core-3nweb-client-lib 0.27.1 → 0.27.3

package/build/lib-client/local-files/device-fs.js

@@ -62,10 +62,10 @@ async function makeFolder(root, path, exclusive = false) {
             continue;
         }
         if (!stats.isDirectory()) {
-            throw (0, file_1.makeFileException)(file_1.Code.notDirectory, path.slice(0, i + 1).join('/'));
+            throw (0, file_1.makeFileException)('notDirectory', path.slice(0, i + 1).join('/'));
         }
         else if ((i === lastIndex) && exclusive) {
-            throw (0, file_1.makeFileException)(file_1.Code.alreadyExists, path.join('/'));
+            throw (0, file_1.makeFileException)('alreadyExists', path.join('/'));
         }
     }
 }
@@ -227,10 +227,10 @@ class DeviceFS {
         await fs.lstat(root)
             .then(stat => {
             if (create && exclusive) {
-                throw (0, file_1.makeFileException)(file_1.Code.alreadyExists, root);
+                throw (0, file_1.makeFileException)('alreadyExists', root);
             }
             if (!stat.isDirectory()) {
-                throw (0, file_1.makeFileException)(file_1.Code.notDirectory, root);
+                throw (0, file_1.makeFileException)('notDirectory', root);
             }
         }, async (e) => {
             if (!e.notFound || !create) {
@@ -455,7 +455,7 @@ class DeviceFS {
             return txt;
         }
         catch (err) {
-            throw (0, file_1.makeFileException)(file_1.Code.parsingError, path, err);
+            throw (0, file_1.makeFileException)('parsingError', path, err);
         }
     }
     writeJSONFile(path, json, flags = WRITE_NONEXCL_FLAGS) {
@@ -469,7 +469,7 @@ class DeviceFS {
             return json;
         }
         catch (err) {
-            throw (0, file_1.makeFileException)(file_1.Code.parsingError, path, err);
+            throw (0, file_1.makeFileException)('parsingError', path, err);
         }
     }
     async deleteFile(path) {
@@ -557,7 +557,7 @@ class DeviceFS {
             const dstPath = this.root + '/' + dst.join('/');
             await fs.lstat(dstPath)
                 .then(() => {
-                throw (0, file_1.makeFileException)(file_1.Code.alreadyExists, newPath);
+                throw (0, file_1.makeFileException)('alreadyExists', newPath);
             }, (exc) => {
                 if (!exc.notFound) {
                     throw exc;
@@ -692,10 +692,10 @@ class DeviceFS {
     async writableFile(path, flags = WRITE_NONEXCL_FLAGS) {
         const exists = await this.checkFilePresence(path);
         if (exists && flags.create && flags.exclusive) {
-            throw (0, file_1.makeFileException)(file_1.Code.alreadyExists, path);
+            throw (0, file_1.makeFileException)('alreadyExists', path);
         }
         if (!exists && !flags.create) {
-            throw (0, file_1.makeFileException)(file_1.Code.notFound, path);
+            throw (0, file_1.makeFileException)('notFound', path);
         }
         return (0, files_1.wrapWritableFile)(new FileObject(this, path, exists, true));
     }
@@ -765,7 +765,7 @@ class DeviceFS {
             }
             try {
                 if (observer.error) {
-                    observer.error((0, file_1.makeFileException)(sig, path, { code, sig }));
+                    observer.error((0, file_1.makeFileExceptionFromCode)(sig, path, { code, sig }));
                 }
                 else if (observer.complete) {
                     observer.complete();
@@ -876,7 +876,7 @@ async function checkFolderPresence(path) {
         throw (0, file_1.maskPathInExc)(0, e);
     });
     if (!stat.isDirectory()) {
-        throw (0, file_1.makeFileException)(file_1.Code.notDirectory, path);
+        throw (0, file_1.makeFileException)('notDirectory', path);
     }
 }
 class FileObject {

package/build/lib-client/user-with-mid-session.d.ts

@@ -8,7 +8,7 @@ import * as WebSocket from 'ws';
 export declare type IGetMailerIdSigner = () => Promise<mid.MailerIdSigner>;
 export declare abstract class ServiceUser {
     readonly userId: string;
-    private readonly getSigner;
+    private getSigner;
     private getInitServiceURI;
     protected readonly net: NetClient;
     private uri;
@@ -28,6 +28,7 @@ export declare abstract class ServiceUser {
     }, getSigner: IGetMailerIdSigner | undefined, getInitServiceURI: () => Promise<string>, net: NetClient);
     private get isUriSet();
     private throwOnBadServiceURI;
+    protected setGetterOfSigner(getSigner: IGetMailerIdSigner): void;
     /**
      * This initializes service uri, if it hasn't been set, yet.
      * Else, this function does nothing.

package/build/lib-client/user-with-mid-session.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015, 2017, 2020 3NSoft Inc.
+ Copyright (C) 2015, 2017, 2020, 2022 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
@@ -72,6 +72,12 @@ class ServiceUser {
             throw new Error(`Service uri is not a string: ${this.serviceURI}`);
         }
     }
+    setGetterOfSigner(getSigner) {
+        if (this.getSigner) {
+            throw new Error(`getSigner is already set`);
+        }
+        this.getSigner = getSigner;
+    }
     /**
      * This initializes service uri, if it hasn't been set, yet.
      * Else, this function does nothing.

package/build/lib-common/async-fs-node.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2019, 2021 3NSoft Inc.
+ Copyright (C) 2015 - 2019, 2021 - 2022 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
@@ -28,7 +28,7 @@ const path_1 = require("path");
 var fs_2 = require("fs");
 Object.defineProperty(exports, "Stats", { enumerable: true, get: function () { return fs_2.Stats; } });
 function makeFileExceptionFromNodes(nodeExc) {
-    return (0, file_1.makeFileException)(nodeExc.code, nodeExc.path);
+    return (0, file_1.makeFileExceptionFromCode)(nodeExc.code, nodeExc.path);
 }
 function readFile(path, options) {
     return new Promise((resolve, reject) => {
@@ -307,7 +307,7 @@ async function readToBuf(fd, pos, buf) {
     while (bytesRead < buf.length) {
         const bNum = await readOrig(fd, buf, bytesRead, buf.length - bytesRead, pos);
         if (bNum === 0) {
-            throw (0, file_1.makeFileException)(file_1.Code.endOfFile, '<file descriptor>');
+            throw (0, file_1.makeFileException)('endOfFile', '<file descriptor>');
         }
         bytesRead += bNum;
         pos += bNum;
@@ -379,7 +379,7 @@ async function existsFolder(path) {
             return true;
         }
         else {
-            throw (0, file_1.makeFileException)(file_1.Code.notDirectory, path);
+            throw (0, file_1.makeFileException)('notDirectory', path);
         }
     }
     catch (e) {
@@ -400,7 +400,7 @@ function existsFolderSync(path) {
             return true;
         }
         else {
-            throw (0, file_1.makeFileException)(file_1.Code.notDirectory, path);
+            throw (0, file_1.makeFileException)('notDirectory', path);
         }
     }
     catch (e) {
@@ -421,7 +421,7 @@ function existsFileSync(path) {
             return true;
         }
         else {
-            throw (0, file_1.makeFileException)(file_1.Code.notFile, path);
+            throw (0, file_1.makeFileException)('notFile', path);
         }
     }
     catch (e) {
@@ -586,7 +586,7 @@ async function streamToExistingFile(filePath, pos, len, src, bufSize) {
         if (doneReading) {
             return;
         }
-        complete((0, file_1.makeFileException)(file_1.Code.endOfFile, '<input stream>'));
+        complete((0, file_1.makeFileException)('endOfFile', '<input stream>'));
     });
     src.on('error', (err) => {
         complete(err);
@@ -614,7 +614,7 @@ async function read(fd, pos, buf) {
     while (bytesRead < buf.length) {
         const bNum = await readOrig(fd, buf, bytesRead, buf.length - bytesRead, pos);
         if (bNum === 0) {
-            throw (0, file_1.makeFileException)(file_1.Code.endOfFile, '<file descriptor>');
+            throw (0, file_1.makeFileException)('endOfFile', '<file descriptor>');
         }
         bytesRead += bNum;
         pos += bNum;

package/build/lib-common/exceptions/file.d.ts

@@ -1,6 +1,8 @@
-export declare const Code: web3n.files.exceptionCode;
 export declare type FileException = web3n.files.FileException;
-export declare function makeFileException(code: string | undefined, path: string, cause?: any): FileException;
+export declare type FileExceptionFlag = web3n.files.FileExceptionFlag;
+export declare const Code: web3n.files.exceptionCode;
+export declare function makeFileExceptionFromCode(code: string | undefined, path: string, cause?: any): FileException;
+export declare function makeFileException(flag: keyof FileExceptionFlag, path: string, cause?: any): FileException;
 export declare function maskPathInExc(pathPrefixMaskLen: number, exc: any): FileException;
 export declare function ensureCorrectFS(fs: web3n.files.FS, type: web3n.files.FSType, writable: boolean): void;
 export declare function makeNoAttrsExc(path: string): FileException;

package/build/lib-common/exceptions/file.js

@@ -16,28 +16,26 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeVersionMismatchExc = exports.makeNoAttrsExc = exports.ensureCorrectFS = exports.maskPathInExc = exports.makeFileException = exports.Code = void 0;
+exports.makeVersionMismatchExc = exports.makeNoAttrsExc = exports.ensureCorrectFS = exports.maskPathInExc = exports.makeFileException = exports.makeFileExceptionFromCode = exports.Code = void 0;
 exports.Code = {
     notFound: 'ENOENT',
     alreadyExists: 'EEXIST',
     notDirectory: 'ENOTDIR',
     notFile: 'ENOTFILE',
-    notLink: 'not-link',
     isDirectory: 'EISDIR',
     notEmpty: 'ENOTEMPTY',
     endOfFile: 'EEOF',
     opNotPermitted: 'EPERM',
     busy: 'EBUSY',
     ioError: 'EIO',
-    concurrentUpdate: 'concurrent-update',
-    parsingError: 'parsing-error',
     notImplemented: 'ENOSYS',
-    isEndless: 'is-endless',
-    storageClosed: 'storage-closed',
-    versionMismatch: 'version-mismatch',
 };
 Object.freeze(exports.Code);
-function makeFileException(code, path, cause) {
+const codeToFlag = {};
+for (const [flag, code] of Object.entries(exports.Code)) {
+    codeToFlag[code] = flag;
+}
+function makeFileExceptionFromCode(code, path, cause) {
     const err = {
         runtimeException: true,
         type: 'file',
@@ -45,59 +43,27 @@ function makeFileException(code, path, cause) {
         path,
         cause
     };
-    if (code === exports.Code.alreadyExists) {
-        err.alreadyExists = true;
-    }
-    else if (code === exports.Code.notFound) {
-        err.notFound = true;
-    }
-    else if (code === exports.Code.isDirectory) {
-        err.isDirectory = true;
-    }
-    else if (code === exports.Code.notDirectory) {
-        err.notDirectory = true;
-    }
-    else if (code === exports.Code.notFile) {
-        err.notFile = true;
-    }
-    else if (code === exports.Code.notLink) {
-        err.notLink = true;
-    }
-    else if (code === exports.Code.endOfFile) {
-        err.endOfFile = true;
-    }
-    else if (code === exports.Code.busy) {
-        err.busy = true;
-    }
-    else if (code === exports.Code.ioError) {
-        err.ioError = true;
-    }
-    else if (code === exports.Code.notEmpty) {
-        err.notEmpty = true;
-    }
-    else if (code === exports.Code.opNotPermitted) {
-        err.opNotPermitted = true;
-    }
-    else if (code === exports.Code.concurrentUpdate) {
-        err.concurrentUpdate = true;
-    }
-    else if (code === exports.Code.parsingError) {
-        err.parsingError = true;
-    }
-    else if (code === exports.Code.notImplemented) {
-        err.notImplemented = true;
-    }
-    else if (code === exports.Code.isEndless) {
-        err.isEndless = true;
-    }
-    else if (code === exports.Code.storageClosed) {
-        err.storageClosed = true;
-    }
-    else if (code === exports.Code.versionMismatch) {
-        err.versionMismatch = true;
+    if (code) {
+        const flag = codeToFlag[code];
+        if (flag) {
+            err[flag] = true;
+        }
     }
     return err;
 }
+exports.makeFileExceptionFromCode = makeFileExceptionFromCode;
+function makeFileException(flag, path, cause) {
+    const code = exports.Code[flag];
+    const err = {
+        runtimeException: true,
+        type: 'file',
+        code,
+        path,
+        cause
+    };
+    err[flag] = true;
+    return err;
+}
 exports.makeFileException = makeFileException;
 function maskPathInExc(pathPrefixMaskLen, exc) {
     if (!exc.runtimeException || !exc.code) {

package/build/lib-common/ipc/generic-ipc.js

@@ -278,11 +278,12 @@ function makeRequestServer(channel, comm) {
     return (new ReplyingSide(channel, comm)).wrap();
 }
 exports.makeRequestServer = makeRequestServer;
-function makeUnknownEventException() {
+function makeUnknownEventException(message) {
     return {
         runtimeException: true,
         type: 'events',
-        unknownEvent: true
+        unknownEvent: true,
+        message
     };
 }
 const SUBSCRIBE_REQ_NAME = 'subscribe';
@@ -307,7 +308,7 @@ class EventsSendingSide extends ReplyingSide {
         const event = env.req;
         const gr = this.findGroup(event);
         if (!gr) {
-            throw makeUnknownEventException();
+            throw makeUnknownEventException(`Events' channel ${event} is not found in handling subscribe`);
         }
         this.subscribedEvents.add(event);
         await gr.subscribe(event);
@@ -316,7 +317,7 @@ class EventsSendingSide extends ReplyingSide {
         const event = env.req;
         const gr = this.findGroup(event);
         if (!gr) {
-            throw makeUnknownEventException();
+            throw makeUnknownEventException(`Events' channel ${event} is not found in handling unsubscribe`);
         }
         this.subscribedEvents.delete(event);
         if (gr.unsubscribe) {

package/build/lib-common/objs-on-disk/utils.js

@@ -111,7 +111,7 @@ async function streamToObjFile(file, content, src, maxBufferLen) {
     });
     src.on('end', () => {
         if (chunk) {
-            complete((0, file_1.makeFileException)(file_1.Code.endOfFile, '<input stream>'));
+            complete((0, file_1.makeFileException)('endOfFile', '<input stream>'));
         }
         else {
             complete();

package/build/lib-common/service-api/3nstorage/owner.d.ts

@@ -128,9 +128,10 @@ export declare namespace currentObj {
         mismatchedObjVer: number;
         objIncomplete: number;
     };
-    interface MismatchedObjVerReply extends ErrorReply {
-        current_version: number;
-    }
+    type MismatchedObjVerReply = MismatchedObjVerErrReply;
+}
+export interface MismatchedObjVerErrReply extends ErrorReply {
+    current_version: number;
 }
 export declare namespace currentRootObj {
     const EXPRESS_URL_END = "root/current";
@@ -236,23 +237,25 @@ export declare namespace rootStatus {
 export declare namespace archiveObj {
     const EXPRESS_URL_END = "obj/:objId/archive";
     function postAndDelReqUrlEnd(objId: string, version: number): string;
-    type VersionsList = number[];
+    type MismatchedObjVerReply = MismatchedObjVerErrReply;
     const SC: {
         okPost: number;
         okDelete: number;
         unknownObj: number;
         unknownObjVer: number;
+        mismatchedObjVer: number;
     };
 }
 export declare namespace archiveRoot {
     const EXPRESS_URL_END = "root/archive";
     function postAndDelReqUrlEnd(version: number): string;
-    type VersionsList = archiveObj.VersionsList;
+    type MismatchedObjVerReply = archiveObj.MismatchedObjVerReply;
     const SC: {
         okPost: number;
         okDelete: number;
         unknownObj: number;
         unknownObjVer: number;
+        mismatchedObjVer: number;
     };
 }
 export interface ErrorReply {

package/build/lib-common/service-api/3nstorage/owner.js

@@ -258,7 +258,8 @@ var archiveObj;
         okPost: 200,
         okDelete: 200,
         unknownObj: 474,
-        unknownObjVer: 494
+        unknownObjVer: 494,
+        mismatchedObjVer: 495
     };
 })(archiveObj = exports.archiveObj || (exports.archiveObj = {}));
 Object.freeze(archiveObj);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.27.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",
@@ -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.2",
+    "spec-3nweb-server": "^1.6.3",
     "typescript": "^4.7.4"
   }
 }

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