core-3nweb-client-lib 0.37.2 → 0.38.0

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

@@ -252,6 +252,10 @@ declare namespace web3n.asmail {
 	}
 
 	interface MsgInfo {
+		/**
+		 * msgId is an identifier generated by user's ASMail server on message
+		 * delivery to identify it in an inbox.
+		 */
 		msgId: string;
 		msgType: string;
 		deliveryTS: number;
@@ -265,6 +269,12 @@ declare namespace web3n.asmail {
 	}
 
 	interface OutgoingMessage extends MsgStruct {
+		/**
+		 * msgId is an identifier generated by recipient's ASMail when message
+		 * delivery process has started. Its purpose is to restart an interrupted
+		 * delivery.
+		 * (Do we even need it here, as core is responsible for restarts?)
+		 */
 		msgId?: string;
 		attachments?: AttachmentsContainer;
 	}

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

@@ -1,5 +1,5 @@
 /*
- Copyright (C) 2016 - 2018, 2020, 2022 3NSoft Inc.
+ Copyright (C) 2016 - 2018, 2020, 2022, 2025 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
@@ -46,6 +46,8 @@ declare namespace web3n.files {
 		isEndless?: true;
 		storageClosed?: true;
 		remoteNotSet?: true;
+		notLinkableFile?: true;
+		notLinkableFolder?: true;
 	}
 
 	interface exceptionCode {

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

@@ -123,6 +123,10 @@ declare namespace web3n.keys {
 
 		introKeyOnASMailServer: IntroKeyOnASMailServer;
 
+		getCorrespondentKeys: (
+			correspondentAddr: string
+		) => Promise<CorrespondentKeysInfo|undefined>;
+
 	}
 
 	interface IntroKeyOnASMailServer {
@@ -151,4 +155,42 @@ declare namespace web3n.keys {
 		provCert: keys.SignedLoad;
 	}
 
+	interface CorrespondentKeysInfo {
+		sendingPair: IntroductorySendingPairInfo|RatchetedSendingPairInfo|null;
+		receptionPairs: {
+			suggested: ReceptionPairInfo|null;
+			inUse: ReceptionPairInfo|null;
+			old: ReceptionPairInfo|null;
+		};
+	}
+
+	interface IntroductorySendingPairInfo {
+		type: 'intro';
+		recipientKId: string;
+	}
+
+	interface RatchetedSendingPairInfo {
+		type: 'ratcheted';
+		pids: string[];
+		timestamp: number;
+		senderKId: string;
+		recipientKId: string;
+		sentMsgs?: {
+			count: number;
+			lastTS: number;
+		};
+	}
+
+	interface ReceptionPairInfo {
+		pids: string[];
+		recipientKId: string;
+		isSenderIntroKey?: boolean,
+		senderKId: string;
+		receivedMsgs?: {
+			counts: number[][];
+			lastTS: number;
+		};
+		timestamp: number;
+	}
+
 }

package/build/core/keyring/correspondent-keys.d.ts

@@ -8,6 +8,7 @@ import { Decryptor } from '../../lib-common/async-cryptor-wrap';
 import { AsyncSBoxCryptor } from 'xsp-files';
 type JsonKey = web3n.keys.JsonKey;
 type JsonKeyShort = web3n.keys.JsonKeyShort;
+type CorrespondentKeysInfo = web3n.keys.CorrespondentKeysInfo;
 export interface ReceptionPair {
     pids: string[];
     recipientKey: JWKeyPair;
@@ -142,5 +143,6 @@ export declare class CorrespondentKeys {
         msgMasterKey: Uint8Array;
         msgCount: number;
     }>;
+    toInfo(): CorrespondentKeysInfo;
 }
 export {};

package/build/core/keyring/correspondent-keys.js

@@ -312,6 +312,17 @@ class CorrespondentKeys {
         }
         return { msgMasterKey, msgCount, currentPair };
     }
+    toInfo() {
+        const { sendingPair: sp, receptionPairs: rp } = this.keys;
+        return {
+            sendingPair: (sp ? turnSendingPairToInfo(sp) : null),
+            receptionPairs: {
+                inUse: (rp.inUse ? turnReceptionPairToInfo(rp.inUse) : null),
+                old: (rp.old ? turnReceptionPairToInfo(rp.old) : null),
+                suggested: (rp.suggested ? turnReceptionPairToInfo(rp.suggested) : null)
+            }
+        };
+    }
 }
 exports.CorrespondentKeys = CorrespondentKeys;
 Object.freeze(CorrespondentKeys.prototype);
@@ -352,4 +363,34 @@ function updateMsgCountInRatchetedSendingPair(p) {
     }
     return p.sentMsgs.count;
 }
+function turnSendingPairToInfo(sp) {
+    if (sp.type === 'ratcheted') {
+        const { pids, timestamp, sentMsgs } = sp;
+        return {
+            type: 'ratcheted',
+            recipientKId: sp.recipientPKey.kid,
+            senderKId: sp.senderKey.pkey.kid,
+            pids,
+            timestamp,
+            sentMsgs
+        };
+    }
+    else if (sp.type === 'intro') {
+        return {
+            type: 'intro',
+            recipientKId: sp.recipientPKey.kid
+        };
+    }
+    else {
+        return null;
+    }
+}
+function turnReceptionPairToInfo(rp) {
+    const { pids, timestamp, receivedMsgs, isSenderIntroKey } = rp;
+    return {
+        pids, timestamp, receivedMsgs, isSenderIntroKey,
+        recipientKId: rp.recipientKey.pkey.kid,
+        senderKId: rp.senderPKey.kid
+    };
+}
 Object.freeze(exports);

package/build/core/keyring/index.js

@@ -319,6 +319,11 @@ class Keyrings {
     makeKeyringsCAP() {
         const w = {
             introKeyOnASMailServer: this.publishedKeys.makeIntroKeyCAP(),
+            getCorrespondentKeys: async (addr) => {
+                var _a;
+                const cAddr = (0, canonical_address_1.toCanonicalAddress)(addr);
+                return (_a = this.corrKeys.get(cAddr)) === null || _a === void 0 ? void 0 : _a.toInfo();
+            }
         };
         return Object.freeze(w);
     }

package/build/core/keyring/keyrings-cap-ipc.js

@@ -23,6 +23,7 @@ const service_side_wrap_1 = require("../../core-ipc/json-ipc-wrapping/service-si
 function exposeKeyringsCAP(cap) {
     return {
         introKeyOnASMailServer: exposeIntroKey(cap.introKeyOnASMailServer),
+        getCorrespondentKeys: (0, service_side_wrap_1.wrapReqReplySrvMethod)(cap, 'getCorrespondentKeys')
     };
 }
 function exposeIntroKey(cap) {
@@ -45,6 +46,7 @@ function makeIntroKeyCaller(caller, objPath) {
 function makeKeyringsCaller(caller, objPath) {
     return {
         introKeyOnASMailServer: makeIntroKeyCaller(caller, objPath.concat('introKeyOnASMailServer')),
+        getCorrespondentKeys: (0, caller_side_wrap_1.makeReqRepFuncCaller)(caller, objPath.concat('getCorrespondentKeys'))
     };
 }
 Object.freeze(exports);

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

@@ -657,9 +657,14 @@ class DeviceFS {
     }
     async link(path, target) {
         // do sanity checks
-        if (!target ||
-            (typeof target.getLinkParams !== 'function')) {
-            throw new Error('Given target is not-linkable');
+        if (!target
+            || (typeof target.getLinkParams !== 'function')) {
+            if (target.listFolder) {
+                throw (0, file_1.makeFileException)('notLinkableFolder', target.name);
+            }
+            else {
+                throw (0, file_1.makeFileException)('notLinkableFile', target.name);
+            }
         }
         const params = await target.getLinkParams();
         // note, we could check (params.storageType !== 'device'), but, since we

package/build/lib-client/xsp-fs/fs.js

@@ -339,9 +339,14 @@ class XspFS {
         throw new Error(`Cannot create link to ${params.storageType} from ${storage.type} storage.`);
     }
     async link(path, target) {
-        if (!target ||
-            (typeof target.getLinkParams !== 'function')) {
-            throw new Error('Given target is not-linkable');
+        if (!target
+            || (typeof target.getLinkParams !== 'function')) {
+            if (target.listFolder) {
+                throw (0, file_1.makeFileException)('notLinkableFolder', target.name);
+            }
+            else {
+                throw (0, file_1.makeFileException)('notLinkableFile', target.name);
+            }
         }
         const params = await target.getLinkParams();
         this.ensureLinkingAllowedTo(params);

package/build/lib-common/service-api/asmail/retrieval.js

@@ -145,4 +145,7 @@ var msgMainObjRecieved;
     msgMainObjRecieved.EVENT_NAME = 'msg-main-obj-received';
 })(msgMainObjRecieved || (exports.msgMainObjRecieved = msgMainObjRecieved = {}));
 Object.freeze(msgMainObjRecieved);
+// XXX add event about message removal
+//   it is useful in multi-device case, pass implicit implicit signal that will
+//   have context-specific meaning.
 Object.freeze(exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.37.2",
+  "version": "0.38.0",
   "description": "3NWeb client core library, embeddable into different environments",
   "main": "build/lib-index.js",
   "types": "build/lib-index.d.ts",