core-3nweb-client-lib 0.24.1 → 0.24.4

package/build/api-defs/mailerid.d.ts

@@ -0,0 +1,29 @@
+/*
+ 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/>.
+*/
+
+
+declare namespace web3n.mailerid {
+
+	interface Service {
+
+		getUserId(): Promise<string>;
+
+		login(serviceUrl: string): Promise<string>;
+
+	}
+
+}

package/build/api-defs/startup.d.ts

@@ -0,0 +1,121 @@
+/*
+ Copyright (C) 2016 - 2017, 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/>.
+*/
+
+
+declare namespace web3n.startup {
+	
+	/**
+	 * This is a collection of functions, that are are used by startup
+	 * functionality, when user creates new account in 3NWeb domains.
+	 */
+	interface SignUpService {
+		
+		/**
+		 * @param name is a part of address that comes before @domain
+		 * @param signupToken
+		 * @return a promise, resolvable to an array of available 3NWeb addresses
+		 * with a given name part of the address.
+		 * Array will be empty, when there are no available addresses for a given
+		 * name.
+		 */
+		getAvailableAddresses(
+			name: string, signupToken?: string
+		): Promise<string[]>;
+		
+		/**
+		 * @param userId
+		 * @param signupToken
+		 * @return a promise, resolvable to flag that indicates whether an account
+		 * for given user has been created (true value), or not (false value).
+		 */
+		addUser(userId: string, signupToken?: string): Promise<boolean>;
+		
+		/**
+		 * @param userId
+		 * @return a promise, resolvable to flag that indicates whether given user
+		 * account is active (true value), or not (false value).
+		 */
+		isActivated(userId: string): Promise<boolean>;
+		
+		/**
+		 * This returns a promise, resolvable when MailerId login and storage
+		 * secret keys, have been derived from a password.
+		 * @param pass
+		 * @param progressCB is a callback for progress notification
+		 */
+		createUserParams(
+			pass: string,
+			progressCB: (progress: number) => void
+		): Promise<void>;
+		
+	}
+	
+	/**
+	 * This is a collection of functions, that are are used by startup
+	 * functionality, when user signs into existing account, whether already
+	 * cached on this device, or not.
+	 */
+	interface SignInService {
+		
+		/**
+		 * This returns an array of users, whose storages are found on a disk.
+		 */
+		getUsersOnDisk(): Promise<string[]>;
+		
+		/**
+		 * This starts a login process, when application is started without user
+		 * storage on a disk.
+		 * It returns a promise, resolvable either to true, if provisioning has
+		 * started, or to false, if given address is not known to the MailerId
+		 * server.
+		 * @param address
+		 */
+		startLoginToRemoteStorage(address: string): Promise<boolean>;
+		
+		/**
+		 * This completes login and setup of user's storage on a disk.
+		 * It returns a promise, resolvable either to true, when provisioning is
+		 * done, or to false, when given password is incorrect.
+		 * @param pass is a MailerId login password
+		 * @param progressCB is a callback for progress notification
+		 */
+		completeLoginAndLocalSetup(
+			pass: string,
+			progressCB: (progress: number) => void
+		): Promise<boolean>;
+		
+		/**
+		 * This method initializes core to run from an existing on a disk storage.
+		 * It returns a promise, resolvable either to true, when password opens
+		 * storage, and to false, when given password is incorrect.
+		 * @param address is user' address.
+		 * @param pass is user's password.
+		 * @param progressCB is a callback for progress notification
+		 */
+		useExistingStorage(
+			address: string, pass: string,
+			progressCB: (progress: number) => void
+		): Promise<boolean>;
+		
+	}
+
+	interface W3N {
+		signIn: startup.SignInService;
+		signUp: startup.SignUpService;
+	}
+	
+}

package/build/api-defs/storage.d.ts

@@ -0,0 +1,69 @@
+/*
+ Copyright (C) 2016 - 2017, 2021 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/>.
+*/
+
+/**
+ * This is a namespace for things used by storage and any file functionality.
+ */
+declare namespace web3n.storage {
+
+	interface Service {
+
+		/**
+		 * This returns a promise of an app's fs in local storage.
+		 * @param appName is a reversed domain. If omitted, this app's main
+		 * domain is assumed.
+		 */
+		getAppLocalFS(appName?: string): Promise<files.WritableFS>;
+
+		/**
+		 * This returns a promise of an app's fs in synced storage.
+		 * @param appName is a reversed domain. If omitted, this app's main
+		 * domain is assumed.
+		 */
+		getAppSyncedFS(appName?: string): Promise<files.WritableFS>;
+
+		/**
+		 * This returns a promise, resolvable to user fs. It will be either
+		 * writable or readonly, depending on app's manifest setting.
+		 * @param type is a type of fs requested, like synced, local, or device.
+		 * @param path is an optional to get more specific fs.
+		 */
+		getUserFS?: (type: StorageType, path?: string) => Promise<files.FSItem>;
+
+		/**
+		 * This returns a promise, resolvable to system fs. It will be either
+		 * writable or readonly, depending on app's manifest setting.
+		 * @param type is a type of fs requested, like synced, local, or device.
+		 * @param path is an optional to get more specific fs.
+		 */
+		getSysFS?: (type: StorageType, path?: string) => Promise<files.FSItem>;
+
+	}
+
+	type StorageType = 'device'|'synced'|'local';
+	type StorageUse = 'user'|'system'|'app';
+
+	interface StorageException extends web3n.RuntimeException {
+		type: 'storage';
+		appName?: string;
+		badAppName?: boolean;
+		notAllowedToOpenFS?: boolean;
+		storageType?: StorageType;
+		storageSegment: StorageUse;
+	}
+
+}

package/build/api-defs/web3n.d.ts

@@ -0,0 +1,50 @@
+/*
+ Copyright (C) 2016 - 2018, 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/>.
+*/
+
+/// <reference path="./asmail.d.ts" />
+/// <reference path="./common-caps.d.ts" />
+/// <reference path="./files.d.ts" />
+/// <reference path="./mailerid.d.ts" />
+/// <reference path="./startup.d.ts" />
+/// <reference path="./storage.d.ts" />
+
+
+declare namespace web3n {
+	
+	interface RuntimeException {
+		runtimeException: true;
+		type?: string;
+		cause?: any;
+		message?: string;
+	}
+
+	interface EncryptionException {
+		failedCipherVerification?: true;
+		failedSignatureVerification?: true;
+	}
+
+	interface AsyncIterator<T> {
+		next(): Promise<IteratorResult<T>>;
+	}
+
+	interface Observer<T> {
+		next?: (value: T) => void;
+		error?: (err: any) => void;
+		complete?: () => void;
+	}
+
+}

package/build/core-ipc/common-caps.d.ts

@@ -3,4 +3,5 @@ import { ClientCAPsWraps, CAPsExposures, TypeDifference } from "./generic";
 declare type W3N = web3n.caps.common.W3N;
 export declare function exposeW3N<T extends W3N>(coreSide: ExposedServices, w3n: T, extraCAPs?: CAPsExposures<TypeDifference<T, W3N>>): void;
 export declare function makeW3Nclient<T extends W3N>(clientSide: Caller, extraCAPs?: ClientCAPsWraps<TypeDifference<T, W3N>>): T;
+export declare function promiseW3Nclient<T extends W3N>(clientSide: Caller, extraCAPs?: ClientCAPsWraps<TypeDifference<T, W3N>>): Promise<T>;
 export {};

package/build/core-ipc/common-caps.js

@@ -16,7 +16,7 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeW3Nclient = exports.exposeW3N = void 0;
+exports.promiseW3Nclient = exports.makeW3Nclient = exports.exposeW3N = void 0;
 const connector_1 = require("../ipc-via-protobuf/connector");
 const log_cap_1 = require("../ipc-via-protobuf/log-cap");
 const asmail_cap_1 = require("../ipc-via-protobuf/asmail-cap");
@@ -46,4 +46,14 @@ function makeW3Nclient(clientSide, extraCAPs) {
     return generic_1.makeClientSide(clientSide, mainCAPs, extraCAPs);
 }
 exports.makeW3Nclient = makeW3Nclient;
+function promiseW3Nclient(clientSide, extraCAPs) {
+    const mainCAPs = {
+        log: log_cap_1.makeLogCaller,
+        mail: asmail_cap_1.makeASMailCaller,
+        mailerid: mailerid_1.makeMailerIdCaller,
+        storage: storage_cap_1.promiseStorageCaller,
+    };
+    return generic_1.promiseClientSide(clientSide, mainCAPs, extraCAPs);
+}
+exports.promiseW3Nclient = promiseW3Nclient;
 Object.freeze(exports);

package/build/core-ipc/generic.d.ts

@@ -11,3 +11,4 @@ export declare type ClientCAPsWraps<T> = {
     [cap in keyof Required<T>]: MakeCapClient;
 };
 export declare function makeClientSide<T extends W3N, W3N extends object>(clientSide: Caller, mainCAPs: ClientCAPsWraps<W3N>, extraCAPs: ClientCAPsWraps<TypeDifference<T, W3N>> | undefined): T;
+export declare function promiseClientSide<T extends W3N, W3N extends object>(clientSide: Caller, mainCAPs: ClientCAPsWraps<W3N>, extraCAPs: ClientCAPsWraps<TypeDifference<T, W3N>> | undefined): Promise<T>;

package/build/core-ipc/generic.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2021 3NSoft Inc.
+ Copyright (C) 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
@@ -16,7 +16,7 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeClientSide = exports.exposeCAPs = void 0;
+exports.promiseClientSide = exports.makeClientSide = exports.exposeCAPs = void 0;
 const connector_1 = require("../ipc-via-protobuf/connector");
 const assert_1 = require("../lib-common/assert");
 function exposeCAPs(coreSide, w3n, mainCAPs, extraCAPs) {
@@ -40,6 +40,7 @@ function addCAPsInExposure(expW3N, coreSide, w3n, capExposures) {
     }
 }
 function makeClientSide(clientSide, mainCAPs, extraCAPs) {
+    assert_1.assert(!!clientSide.listObj);
     const objPath = [connector_1.W3N_NAME];
     const lstOfCAPs = clientSide.listObj(objPath);
     const w3n = {};
@@ -51,7 +52,6 @@ function makeClientSide(clientSide, mainCAPs, extraCAPs) {
             w3n[cap] = makeCap(clientSide, capObjPath);
         }
         else if (extraCAPs) {
-            assert_1.assert(!!exposeCAPs);
             const makeCap = extraCAPs[cap];
             assert_1.assert(typeof makeCap === 'function');
             w3n[cap] = makeCap(clientSide, capObjPath);
@@ -60,4 +60,25 @@ function makeClientSide(clientSide, mainCAPs, extraCAPs) {
     return w3n;
 }
 exports.makeClientSide = makeClientSide;
+async function promiseClientSide(clientSide, mainCAPs, extraCAPs) {
+    assert_1.assert(!!clientSide.listObjAsync);
+    const objPath = [connector_1.W3N_NAME];
+    const lstOfCAPs = (await clientSide.listObjAsync(objPath));
+    const w3n = {};
+    for (const cap of lstOfCAPs) {
+        const capObjPath = objPath.concat(cap);
+        if (mainCAPs[cap]) {
+            const makeCap = mainCAPs[cap];
+            assert_1.assert(typeof makeCap === 'function');
+            w3n[cap] = await makeCap(clientSide, capObjPath);
+        }
+        else if (extraCAPs) {
+            const makeCap = extraCAPs[cap];
+            assert_1.assert(typeof makeCap === 'function');
+            w3n[cap] = await makeCap(clientSide, capObjPath);
+        }
+    }
+    return w3n;
+}
+exports.promiseClientSide = promiseClientSide;
 Object.freeze(exports);

package/build/ipc-via-protobuf/connector-clients-side.d.ts

@@ -4,12 +4,13 @@ import { ClientsSide, EnvelopeBody, Envelope, IPCException, Caller } from "./con
 export declare class ClientsSideImpl implements ClientsSide {
     private readonly sendMsg;
     private readonly syncReqToListObj;
+    private readonly asyncReqToListObj;
     private readonly fnCalls;
     private fnCallCounter;
     private readonly weakRefs;
     private readonly srvRefs;
     private isStopped;
-    constructor(sendMsg: (msg: Envelope) => void, syncReqToListObj: (path: string[]) => string[]);
+    constructor(sendMsg: (msg: Envelope) => void, syncReqToListObj: Caller['listObj'], asyncReqToListObj: Caller['listObjAsync']);
     stop(exc: IPCException): void;
     private sendCallCancellation;
     processInterimCallReply(fnCallNum: number, body: EnvelopeBody): void;
@@ -25,4 +26,5 @@ export declare class ClientsSideImpl implements ClientsSide {
     private sendObjDropMsg;
     srvRefOf(clientObj: any): ObjectReference<any>;
     listObj(path: string[]): string[];
+    listObjAsync(path: string[]): Promise<string[]>;
 }

package/build/ipc-via-protobuf/connector-clients-side.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2020 - 2021 3NSoft Inc.
+ Copyright (C) 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
@@ -24,14 +24,19 @@ const connector_1 = require("./connector");
 // XXX can have an optimized use of WeakRef and FinalizationRegistry, when
 // these are available.
 class ClientsSideImpl {
-    constructor(sendMsg, syncReqToListObj) {
+    constructor(sendMsg, syncReqToListObj, asyncReqToListObj) {
         this.sendMsg = sendMsg;
         this.syncReqToListObj = syncReqToListObj;
+        this.asyncReqToListObj = asyncReqToListObj;
         this.fnCalls = new Map();
         this.fnCallCounter = 1;
         this.weakRefs = new Set();
         this.srvRefs = new WeakMap();
         this.isStopped = false;
+        if ((this.asyncReqToListObj && this.syncReqToListObj)
+            || (!this.asyncReqToListObj && !this.syncReqToListObj)) {
+            throw new Error(`Expect either sync or async obj listing function.`);
+        }
         Object.seal(this);
     }
     stop(exc) {
@@ -126,7 +131,9 @@ class ClientsSideImpl {
     }
     caller() {
         const callerWrap = {
-            listObj: this.listObj.bind(this),
+            listObj: (this.syncReqToListObj ? this.listObj.bind(this) : undefined),
+            listObjAsync: (this.asyncReqToListObj ?
+                this.listObjAsync.bind(this) : undefined),
             registerClientDrop: this.registerClientDrop.bind(this),
             srvRefOf: this.srvRefOf.bind(this),
             startObservableCall: this.startObservableCall.bind(this),
@@ -201,6 +208,12 @@ class ClientsSideImpl {
         }
         return this.syncReqToListObj(path);
     }
+    listObjAsync(path) {
+        if (this.isStopped) {
+            throw connector_1.makeIPCException({ 'ipcNotConnected': true });
+        }
+        return this.asyncReqToListObj(path);
+    }
 }
 exports.ClientsSideImpl = ClientsSideImpl;
 Object.freeze(ClientsSideImpl.prototype);

package/build/ipc-via-protobuf/connector.d.ts

@@ -21,7 +21,8 @@ export interface Caller {
     startObservableCall(path: string[], req: EnvelopeBody, obs: Subject<EnvelopeBody>): () => void;
     registerClientDrop(o: any, srvRef: ObjectReference<any>): void;
     srvRefOf(clientObj: any): ObjectReference<any>;
-    listObj(path: string[]): string[];
+    listObj?: (path: string[]) => string[];
+    listObjAsync?: (path: string[]) => Promise<string[]>;
 }
 export interface ClientsSide {
     caller(): Caller;
@@ -35,7 +36,7 @@ export declare class ObjectsConnector {
     private messagingProc;
     private readonly services;
     private readonly clients;
-    constructor(msgSink: Observer<Envelope>, msgSrc: Observable<Envelope>, sides: 'clients' | 'services' | 'clients-and-services', listObjOnServiceSide?: (path: string[]) => string[] | null);
+    constructor(msgSink: Observer<Envelope>, msgSrc: Observable<Envelope>, sides: 'clients' | 'services' | 'clients-and-services', listObj?: Caller['listObj'], listObjAsync?: Caller['listObjAsync']);
     get caller(): Caller;
     get exposedServices(): ExposedServices;
     private stop;

package/build/ipc-via-protobuf/connector.js

@@ -27,12 +27,12 @@ function makeServicesSide(sendMsg) {
     const srvClassFn = require('./connector-services-side').ServicesSideImpl;
     return new srvClassFn(sendMsg);
 }
-function makeClientsSide(sendMsg, syncReqToListObj) {
+function makeClientsSide(sendMsg, syncReqToListObj, asyncReqToListObj) {
     const classFn = require('./connector-clients-side').ClientsSideImpl;
     return new classFn(sendMsg, syncReqToListObj);
 }
 class ObjectsConnector {
-    constructor(msgSink, msgSrc, sides, listObjOnServiceSide) {
+    constructor(msgSink, msgSrc, sides, listObj, listObjAsync) {
         this.msgSink = msgSink;
         this.messagingProc = undefined;
         this.messagingProc = msgSrc.subscribe({
@@ -49,10 +49,11 @@ class ObjectsConnector {
         this.services = (((sides === 'services') || (sides === 'clients-and-services')) ?
             makeServicesSide(sendMsg) : undefined);
         if ((sides === 'clients') || (sides === 'clients-and-services')) {
-            if (!listObjOnServiceSide) {
-                throw new Error(`Client side needs listObjOnServiceSide argument`);
+            if ((!listObj && !listObjAsync)
+                || (listObj && listObjAsync)) {
+                throw new Error(`Client side needs either listObj, or listObjAsync argument`);
             }
-            this.clients = makeClientsSide(sendMsg, listObjOnServiceSide);
+            this.clients = makeClientsSide(sendMsg, listObj, listObjAsync);
         }
         else {
             this.clients = undefined;

package/build/ipc-via-protobuf/storage-cap.d.ts

@@ -2,4 +2,5 @@ import { ExposedObj, Caller, ExposedServices } from './connector';
 declare type Storage = web3n.storage.Service;
 export declare function exposeStorageCAP(cap: Storage, expServices: ExposedServices): ExposedObj<Storage>;
 export declare function makeStorageCaller(caller: Caller, objPath: string[]): Storage;
+export declare function promiseStorageCaller(caller: Caller, objPath: string[]): Promise<Storage>;
 export {};

package/build/ipc-via-protobuf/storage-cap.js

@@ -16,7 +16,7 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeStorageCaller = exports.exposeStorageCAP = void 0;
+exports.promiseStorageCaller = exports.makeStorageCaller = exports.exposeStorageCAP = void 0;
 const protobuf_msg_1 = require("./protobuf-msg");
 const fs_1 = require("./fs");
 const protobuf_type_1 = require("../lib-client/protobuf-type");
@@ -37,6 +37,15 @@ function exposeStorageCAP(cap, expServices) {
 exports.exposeStorageCAP = exposeStorageCAP;
 function makeStorageCaller(caller, objPath) {
     const lstStorageCAP = caller.listObj(objPath);
+    return instantiateStorageCaller(caller, lstStorageCAP, objPath);
+}
+exports.makeStorageCaller = makeStorageCaller;
+async function promiseStorageCaller(caller, objPath) {
+    const lstStorageCAP = (await caller.listObjAsync(objPath));
+    return instantiateStorageCaller(caller, lstStorageCAP, objPath);
+}
+exports.promiseStorageCaller = promiseStorageCaller;
+function instantiateStorageCaller(caller, lstStorageCAP, objPath) {
     const sysFS = lstStorageCAP.includes('getSysFS');
     const userFS = lstStorageCAP.includes('getUserFS');
     const storage = {
@@ -51,7 +60,6 @@ function makeStorageCaller(caller, objPath) {
     }
     return storage;
 }
-exports.makeStorageCaller = makeStorageCaller;
 var getAppLocalFS;
 (function (getAppLocalFS) {
     const requestType = protobuf_type_1.ProtoType.for(storage_proto_1.storage.GetAppLocalFSRequestBody);

package/build/lib-index.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="api-defs/web3n.d.ts" />
 export * from "./core-ipc/common-caps";
 export * from "./core-ipc/startup-caps";
 export * from "./ipc-via-protobuf/connector";

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.24.1",
+  "version": "0.24.4",
   "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/build-wasm-cryptor.sh",
+    "build": "bash packing/protos-to-node-module.sh && tsc -p ts-code && bash packing/copy-api.sh && bash packing/build-wasm-cryptor.sh",
     "test": "node build/tests/jasmine.js"
   },
   "repository": {