core-3nweb-client-lib 0.24.1 → 0.24.2

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/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.2",
   "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": {