core-3nweb-client-lib 0.49.6 → 0.49.7

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

@@ -314,7 +314,7 @@ declare namespace web3n.files {
 		 * sink with this error. When err is given, no errors will be thrown back
 		 * to this call.
 		 */
-		done(err?: any, xattrChanges?: XAttrsChanges): Promise<void>;
+		done(err?: any): Promise<void>;
 
 	}
 
@@ -1178,27 +1178,33 @@ declare namespace web3n.files {
 	type RemoteEvent = RemoteVersionArchivalEvent | RemoteArchVerRemovalEvent |
 		RemoteRemovalEvent | RemoteChangeEvent;
 
+	/**
+	 * SyncStatus has fields that connect to item's parent, uploading, i.e. not just state of the item.
+	 * Hence, we pick only related fields.
+	 */
+	type ItemSyncStatus = Pick<SyncStatus, 'state' | 'remote' | 'synced' | 'local'>;
+
 	interface RemoteVersionArchivalEvent extends FSEvent {
 		type: 'remote-version-archival';
 		archivedVersion: number;
-		syncStatus: SyncStatus;
+		syncStatus: ItemSyncStatus;
 	}
 
 	interface RemoteArchVerRemovalEvent extends FSEvent {
 		type: 'remote-arch-ver-removal';
 		removedArchVer: number;
-		syncStatus: SyncStatus;
+		syncStatus: ItemSyncStatus;
 	}
 
 	interface RemoteRemovalEvent extends FSEvent {
 		type: 'remote-removal';
-		syncStatus: SyncStatus;
+		syncStatus: ItemSyncStatus;
 	}
 
 	interface RemoteChangeEvent extends FSEvent {
 		type: 'remote-change';
 		newRemoteVersion: number;
-		syncStatus: SyncStatus;
+		syncStatus: ItemSyncStatus;
 	}
 
 	type UploadEvent = UploadStartEvent | UploadProgressEvent | UploadDisconnectedEvent | UploadDoneEvent;

package/build/core/asmail/delivery/common.d.ts

@@ -40,22 +40,17 @@ export interface ResourcesForSending {
          * @param address
          */
         needIntroKeyFor(address: string): boolean;
-        /**
-         * This function generates keys that are needed to send a message, i.e.
-         * current crypto encryptor and identifiers to place in message's meta.
-         * Returned object has following fields:
-         * (a) encryptor - with encryptor, which should be used to pack message's
-         * main part's key,
-         * (b) currentPair - contains sendable form for current key pair.
-         * (c) msgCount - message count for a current pair.
-         * @param address
-         * @param introPKeyFromServer is an optional recipient's key from a mail
-         * server.
-         */
-        generateKeysToSend: (address: string, introPKeyFromServer?: JsonKey) => Promise<{
+        getEstablishedKeysToSendMsg: (address: string) => Promise<{
+            encryptor: Encryptor;
+            currentPair: ASMailKeyPair;
+            msgCount: number;
+            nextMsgCrypto?: SuggestedNextKeyPair;
+        }>;
+        generateIntroKeysToSendMsg: (address: string, introPKey: JsonKey) => Promise<{
             encryptor: Encryptor;
             currentPair: ASMailKeyPair;
             msgCount: number;
+            nextMsgCrypto?: SuggestedNextKeyPair;
         }>;
         /**
          * This function returns sending parameters that should be used now to
@@ -64,11 +59,6 @@ export interface ResourcesForSending {
          * @param address
          */
         paramsForSendingTo: (address: string) => SendingParams | undefined;
-        /**
-         * This function returns next key pair
-         * @param address
-         */
-        nextCrypto: (address: string) => Promise<SuggestedNextKeyPair | undefined>;
         /**
          * This returns a new sending parameters that given address should use to
          * send messages back. Undefined is returned, if current parameters don't
@@ -89,14 +79,4 @@ export interface SavedMsgToSend {
     recipients: string[];
     retryOpts: DeliveryOptions['retryRecipient'];
 }
-/**
- * This is a utility function that adds a number into given number line
- * segments. Each segment is represented by an array, in which 0-th element is
- * the smallest number in the segment, while 1-st element is the largest.
- * Segments don't overlap and are ordered as they would on a number line:
- * segment with smaller numbers go first.
- * @param segments
- * @param n
- */
-export declare function addToNumberLineSegments(segments: number[][], n: number): void;
 export {};

package/build/core/asmail/delivery/common.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2016 - 2017, 2020 3NSoft Inc.
+ Copyright (C) 2016 - 2017, 2020, 2026 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
@@ -18,7 +18,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SEG_SIZE_IN_K_QUATS = exports.Attachments = void 0;
 exports.estimatePackedSizeOf = estimatePackedSizeOf;
-exports.addToNumberLineSegments = addToNumberLineSegments;
 const attachments_container_1 = require("../msg/attachments-container");
 const buffer_utils_1 = require("../../../lib-common/buffer-utils");
 const ATTACHMENTS_NAME = 'attachments';
@@ -139,49 +138,4 @@ function estimatePackedSizeOf(size) {
     }
     return 148 + numOfCompleteSegs * exports.SEG_SIZE_IN_K_QUATS * 256 + lastSegSize;
 }
-/**
- * This is a utility function that adds a number into given number line
- * segments. Each segment is represented by an array, in which 0-th element is
- * the smallest number in the segment, while 1-st element is the largest.
- * Segments don't overlap and are ordered as they would on a number line:
- * segment with smaller numbers go first.
- * @param segments
- * @param n
- */
-function addToNumberLineSegments(segments, n) {
-    for (let i = (segments.length - 1); i >= 0; i -= 1) {
-        const [low, high] = segments[i];
-        if (high < n) {
-            if ((high + 1) >= n) {
-                // segment should be grown on a high side.
-                // But now bigger segment won't merge with higher segment, cause if
-                // it does, it would've merge from lower side of a higher segment.
-                segments[i][1] = n;
-            }
-            else {
-                // new segment should be added higher than this one
-                segments.splice(i + 1, 0, [n, n]);
-            }
-            return;
-        }
-        if ((low <= n) && (n <= high)) {
-            // do nothing as number falls into current segment
-            return;
-        }
-        if (low <= (n + 1)) {
-            // segment should be grown on a lower side
-            segments[i][0] = n;
-            if ((i - 1) >= 0) {
-                // bigger segment may overlap with a lower one
-                const lowerSeg = segments[i - 1];
-                if ((lowerSeg[1] + 1) >= n) {
-                    lowerSeg[1] = high;
-                    segments.splice(i, 1);
-                }
-            }
-            return;
-        }
-    }
-    segments.unshift([n, n]);
-}
 Object.freeze(exports);

package/build/core/asmail/delivery/index.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2016 - 2017, 2020 - 2023 3NSoft Inc.
+ Copyright (C) 2016 - 2017, 2020 - 2023, 2026 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,8 +28,8 @@ const utils_for_observables_1 = require("../../../lib-common/utils-for-observabl
 const SMALL_MSG_SIZE = 1024 * 1024;
 const MSGS_FOLDER = 'msgs';
 function idToMsgFolder(id) {
-    if (id.indexOf('/') > -1) {
-        throw new Error(`Message id ${id} contains illegal character '/'.`);
+    if (id.includes('/') || id.includes('.')) {
+        throw new Error(`Message id ${id} contains illegal character(s).`);
     }
     return `${MSGS_FOLDER}/${id}`;
 }

package/build/core/asmail/delivery/per-recipient-wip.js

@@ -161,7 +161,9 @@ class WIP {
         const introPKeyFromServer = await this.getIntroKeyIfRecipientIsUnknown(recipient);
         this.packer = await this.msg.msgPacker();
         // get crypto parts for encrypting this message
-        const { currentPair, encryptor, msgCount } = await this.msg.r.correspondents.generateKeysToSend(recipient, introPKeyFromServer);
+        const { currentPair, encryptor, msgCount, nextMsgCrypto } = await (introPKeyFromServer ?
+            this.msg.r.correspondents.generateIntroKeysToSendMsg(recipient, introPKeyFromServer) :
+            this.msg.r.correspondents.getEstablishedKeysToSendMsg(recipient));
         // add crypto parameters to the message
         if (currentPair.pid) {
             this.packer.setEstablishedKeyPairInfo(currentPair.pid, msgCount);
@@ -176,7 +178,6 @@ class WIP {
             this.packer.setNewKeyInfo(currentPair.recipientKid, currentPair.senderPKey.k, pkCerts, msgCount);
         }
         // add next crypto parameters to the message
-        const nextMsgCrypto = await this.msg.r.correspondents.nextCrypto(recipient);
         if (nextMsgCrypto) {
             this.packer.setNextCrypto(nextMsgCrypto);
         }

package/build/core/asmail/inbox/index.d.ts

@@ -86,7 +86,7 @@ export declare class InboxOnServer {
     private readonly procs;
     private readonly recentlyOpenedMsgs;
     private constructor();
-    static makeAndStart(cachePath: string, syncedFS: WritableFS, r: ResourcesForReceiving): Promise<InboxOnServer>;
+    static makeAndStart(cachePath: string, syncedFS: WritableFS, localFS: WritableFS, r: ResourcesForReceiving): Promise<InboxOnServer>;
     close(): Promise<void>;
     makeCAP(): InboxService;
     private removeMsg;
@@ -95,7 +95,6 @@ export declare class InboxOnServer {
     private startCachingAndAddKeyToIndex;
     private markOwnParams;
     private absorbSendingParams;
-    private checkServerAuthIfPresent;
     private listMsgs;
     private listNewMsgs;
     private getMsg;

package/build/core/asmail/inbox/index.js

@@ -55,15 +55,15 @@ class InboxOnServer {
         this.inboxEvents = new inbox_events_1.InboxEvents(this.msgReceiver, this.getMsg.bind(this), this.listNewMsgs.bind(this), this.removeMsg.bind(this), this.logError);
         Object.seal(this);
     }
-    static async makeAndStart(cachePath, syncedFS, r) {
+    static async makeAndStart(cachePath, syncedFS, localFS, r) {
         try {
             (0, file_1.ensureCorrectFS)(syncedFS, 'synced', true);
             const msgReceiver = new recipient_1.MailRecipient(r.address, r.getSigner, () => r.asmailResolver(r.address), r.makeNet());
             const downloader = new msg_downloader_1.MsgDownloader(msgReceiver);
             const cache = await cached_msgs_1.CachedMessages.makeFor(cachePath, downloader, r.logError);
-            const indexSyncedFS = await (0, fs_sync_utils_1.getOrMakeAndUploadFolderIn)(syncedFS, MSG_INDEX_FOLDER);
-            const index = await msg_indexing_1.MsgIndex.make(indexSyncedFS);
-            await (0, fs_sync_utils_1.uploadFolderChangesIfAny)(syncedFS);
+            const indexSyncedFS = await (0, fs_sync_utils_1.getOrMakeSyncedDirOnInit)(syncedFS, MSG_INDEX_FOLDER);
+            const indexLocalFS = await localFS.writableSubRoot(MSG_INDEX_FOLDER);
+            const index = await (0, msg_indexing_1.makeMsgIndex)(indexSyncedFS, indexLocalFS, r.logError);
             const inbox = new InboxOnServer(r.correspondents, msgReceiver, r.getStorages, r.cryptor, r.random, downloader, cache, index, r.logError);
             return inbox;
         }
@@ -141,7 +141,7 @@ class InboxOnServer {
             if (decrOut) {
                 const { decrInfo, openedMsg } = decrOut;
                 openedMsg.setMsgKeyRole(decrInfo.keyStatus);
-                this.checkServerAuthIfPresent(meta, decrInfo);
+                checkServerAuthIfPresent(meta, decrInfo);
                 // add records cache and to index
                 this.recentlyOpenedMsgs.set(msgId, openedMsg);
                 const msgInfo = {
@@ -189,14 +189,6 @@ class InboxOnServer {
         const address = openedMsg.sender;
         await this.r.saveParamsForSendingTo(address, sendingParams);
     }
-    checkServerAuthIfPresent(meta, decrInfo) {
-        // if sender authenticated to server, check that it matches address,
-        // recovered from message decryption 
-        if (meta.authSender
-            && !(0, canonical_address_1.areAddressesEqual)(meta.authSender, decrInfo.correspondent)) {
-            throw new Error(`Sender authenticated to server as ${meta.authSender}, while decrypting key is associated with ${decrInfo.correspondent}`);
-        }
-    }
     async listMsgs(fromTS) {
         const checkServer = true; // XXX in future this will be an option from req
         if (!checkServer) {
@@ -272,8 +264,8 @@ class InboxOnServer {
             if (msg) {
                 return this.msgToUIForm(msg, msgOnDisk.deliveryTS, msgOnDisk);
             }
-            if ((msgOnDisk.keyStatus === 'not-found') ||
-                (msgOnDisk.keyStatus === 'fail')) {
+            if ((msgOnDisk.keyStatus === 'not-found')
+                || (msgOnDisk.keyStatus === 'fail')) {
                 // XXX 
                 // message cannot be opened, and should be removed
                 // await Promise.all([
@@ -342,4 +334,11 @@ class InboxOnServer {
 exports.InboxOnServer = InboxOnServer;
 Object.freeze(InboxOnServer.prototype);
 Object.freeze(InboxOnServer);
+function checkServerAuthIfPresent(meta, { correspondent }) {
+    // if sender authenticated to server, check that it matches address,
+    // recovered from message decryption 
+    if (meta.authSender && !(0, canonical_address_1.areAddressesEqual)(meta.authSender, correspondent)) {
+        throw new Error(`Sender authenticated to server as ${meta.authSender}, while decrypting key is associated with ${correspondent}`);
+    }
+}
 Object.freeze(exports);

package/build/core/asmail/inbox/msg-indexing/dataset/v0/sql-db-v-none.d.ts

@@ -0,0 +1,11 @@
+import { Database } from '../../../../../../lib-sqlite-on-3nstorage/sqljs';
+export interface MsgIndexDbVNoneEntry {
+    msg_id: string;
+    msg_type: string;
+    delivery_ts: number;
+    key: Uint8Array;
+    key_status: string;
+    main_obj_header_ofs: number;
+    remove_after: number;
+}
+export declare function getAllRecordsFromVersionNone(db: Database): MsgIndexDbVNoneEntry[];

package/build/core/asmail/inbox/msg-indexing/dataset/v0/sql-db-v-none.js

@@ -0,0 +1,25 @@
+"use strict";
+/*
+ Copyright (C) 2026 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/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllRecordsFromVersionNone = getAllRecordsFromVersionNone;
+const lib_sqlite_on_3nstorage_1 = require("../../../../../../lib-sqlite-on-3nstorage");
+function getAllRecordsFromVersionNone(db) {
+    const result = db.exec(`--sql
+		SELECT * FROM inbox_index`)[0];
+    return (result ? (0, lib_sqlite_on_3nstorage_1.objectFromQueryExecResult)(result) : []);
+}

package/build/core/asmail/inbox/msg-indexing/dataset/v1/logs.d.ts

@@ -0,0 +1,33 @@
+import { SingleProc } from '../../../../../../lib-common/processes/synced';
+import { MsgKeyInfo, MsgKeyRole } from '../../../../../keyring';
+import { LogError } from '../../../../../../lib-client/logging/log-to-file';
+type WritableFS = web3n.files.WritableFS;
+type MsgInfo = web3n.asmail.MsgInfo;
+interface MsgOpenedLog {
+    eventType: 'msg-opened';
+    eventTS: number;
+    msgId: string;
+    msgType: string;
+    deliveryTS: number;
+    keyB64: string;
+    keyStatus: MsgKeyRole;
+    mainObjHeaderOfs: number;
+}
+interface MsgRemovedLog {
+    eventType: 'msg-removed';
+    eventTS: number;
+    msgId: string;
+    deliveryTS: number;
+}
+export type MsgOp = MsgOpenedLog | MsgRemovedLog;
+export declare function msgOpenedEventToRecordParams(op: MsgOpenedLog): {
+    msgInfo: MsgInfo;
+    decrInfo: MsgKeyInfo;
+};
+export declare function makeRecentMsgIndexChangesLogs(logsFS: WritableFS, localLogsFS: WritableFS, logError: LogError): Promise<{
+    recordMsgAddition: (msgInfo: MsgInfo, decrInfo: MsgKeyInfo) => Promise<void>;
+    recordMsgRemoval: (msgId: string, deliveryTS: number) => Promise<void>;
+    watchAndApplyOpsFromOtherDevices: (changeProc: SingleProc, sink: (ops: import("../../../../../../lib-common/dataset-sync/per-device-json-array-logs").LogEntry<MsgOp>[]) => Promise<void>) => () => void;
+    cutLogOnDatasetSyncAndUpload: (syncPointV: number, params?: any) => Promise<void> | undefined;
+}>;
+export {};

package/build/core/asmail/inbox/msg-indexing/dataset/v1/logs.js

@@ -0,0 +1,72 @@
+"use strict";
+/*
+ Copyright (C) 2016 - 2020, 2023, 2026 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/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.msgOpenedEventToRecordParams = msgOpenedEventToRecordParams;
+exports.makeRecentMsgIndexChangesLogs = makeRecentMsgIndexChangesLogs;
+const buffer_utils_1 = require("../../../../../../lib-common/buffer-utils");
+const per_device_json_array_logs_1 = require("../../../../../../lib-common/dataset-sync/per-device-json-array-logs");
+function msgOpenedEventToRecordParams(op) {
+    const { msgType, msgId, deliveryTS, keyB64, keyStatus, mainObjHeaderOfs } = op;
+    return {
+        msgInfo: {
+            msgId, msgType, deliveryTS
+        },
+        decrInfo: {
+            correspondent: '',
+            keyStatus,
+            msgKeyPackLen: mainObjHeaderOfs,
+            key: buffer_utils_1.base64.open(keyB64)
+        }
+    };
+}
+function areOpsEqual(a, b) {
+    return ((a.eventType === b.eventType) && (a.msgId === b.msgId) && (a.deliveryTS === b.deliveryTS));
+}
+async function makeRecentMsgIndexChangesLogs(logsFS, localLogsFS, logError) {
+    const { appendLogsAndUpload, cutLogOnDatasetSyncAndUpload, watchAndApplyOpsFromOtherDevices } = await (0, per_device_json_array_logs_1.makeRecentChangesLogs)(logsFS, localLogsFS, areOpsEqual, logError);
+    function recordMsgAddition(msgInfo, decrInfo) {
+        if (!decrInfo.key) {
+            throw new Error(`Given message decryption info doesn't have a key for message ${msgInfo.msgId}`);
+        }
+        return appendLogsAndUpload({
+            eventType: 'msg-opened',
+            eventTS: Date.now(),
+            msgType: msgInfo.msgType,
+            msgId: msgInfo.msgId,
+            deliveryTS: msgInfo.deliveryTS,
+            keyB64: buffer_utils_1.base64.pack(decrInfo.key),
+            keyStatus: decrInfo.keyStatus,
+            mainObjHeaderOfs: decrInfo.msgKeyPackLen,
+        });
+    }
+    function recordMsgRemoval(msgId, deliveryTS) {
+        return appendLogsAndUpload({
+            eventType: 'msg-removed',
+            eventTS: Date.now(),
+            msgId,
+            deliveryTS
+        });
+    }
+    return {
+        recordMsgAddition,
+        recordMsgRemoval,
+        watchAndApplyOpsFromOtherDevices,
+        cutLogOnDatasetSyncAndUpload
+    };
+}
+Object.freeze(exports);

package/build/core/asmail/inbox/msg-indexing/dataset/v1/sql-db.d.ts

@@ -0,0 +1,28 @@
+import { MsgKeyInfo, MsgKeyRole } from '../../../../../keyring';
+import { MsgOp } from './logs';
+import { SingleProc } from '../../../../../../lib-common/processes/synced';
+import { LogEntry } from '../../../../../../lib-common/dataset-sync/per-device-json-array-logs';
+type WritableFS = web3n.files.WritableFS;
+type WritableFile = web3n.files.WritableFile;
+type MsgInfo = web3n.asmail.MsgInfo;
+export interface MsgKey {
+    msgKey: Uint8Array;
+    msgKeyRole: MsgKeyRole;
+    mainObjHeaderOfs: number;
+}
+export declare function makeSqliteDBs(dbsFS: WritableFS): Promise<{
+    absorbOpsFromOtherDevices: (changeProc: SingleProc, ops: LogEntry<MsgOp>[]) => Promise<void>;
+    addToLatest: (msgInfo: MsgInfo, decrInfo: MsgKeyInfo) => Promise<boolean>;
+    getDBFile: (fileTS: number) => Promise<WritableFile>;
+    getKeyFor: (msgId: string, deliveryTS: number) => Promise<MsgKey | undefined>;
+    isForLatestDb: (deliveryTS: number) => boolean;
+    latestDbHasNewRemoteVersion: () => Promise<boolean>;
+    listMsgs: (fromTS: number | undefined) => Promise<MsgInfo[]>;
+    msgExists: ({ msgId, deliveryTS }: MsgInfo) => Promise<boolean>;
+    makeNewShardWithRecordsUpToTS: (shardTS: number) => Promise<number>;
+    syncPastShards: () => Promise<void>;
+    numberOfRecordsInLatestBefore: (ts: number) => number;
+    remove: (msgId: string) => Promise<number | undefined>;
+    watchAndApplyOpsFromOtherDevices: (changeProc: SingleProc, resetSyncInterval: () => void) => () => void;
+}>;
+export {};