spec-3nweb-server 1.7.14 → 1.8.1

package/build/3nstorage/3nstorage-app.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2016, 2020 3NSoft Inc.
+ Copyright (C) 2015 - 2016, 2020, 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
@@ -35,8 +35,8 @@ function setupStaticStorageEntryRoute(app) {
             path = path + '/';
         }
         const json = {
-            "owner": path + PATHS.owner.substring(1),
-            "shared": path + PATHS.shared.substring(1)
+            owner: path + PATHS.owner.substring(1),
+            shared: path + PATHS.shared.substring(1)
         };
         // the following implicitly sets content type application/json
         res.status(200).json(json);

package/build/3nstorage/owner.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2017, 2022, 2024 3NSoft Inc.
+ Copyright (C) 2015 - 2017, 2022, 2024 - 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
@@ -33,10 +33,10 @@ const archive_obj_version_1 = require("./routes/owner/archive-obj-version");
 const get_obj_status_1 = require("./routes/owner/get-obj-status");
 const api = require("../lib-common/service-api/3nstorage/owner");
 const mid_access_1 = require("../lib-server/mid-access");
+const WS_PING_PERIOD_MILLIS = 2 * 60 * 1000;
 function makeOwnerStorageApp(domain, sessions, users, midAuthorizer) {
     const app = new app_1.AppWithWSs();
-    const setupLoginRoutes = (app, urlPrefix) => (0, mid_access_1.addMailerIdLoginRoutes)(app, domain, urlPrefix, sessions, users.exists, midAuthorizer);
-    setHttpPart(app.http, setupLoginRoutes, sessions, users);
+    setHttpPart(app.http, domain, sessions, users, midAuthorizer);
     setWSPart(app, sessions, users);
     return app;
 }
@@ -55,7 +55,7 @@ function makeOwnerStorageForLocker(sessions, users) {
 }
 exports.makeOwnerStorageForLocker = makeOwnerStorageForLocker;
 function setWSPart(app, sessions, users) {
-    const sockets = new app_1.UserSockets(sessions.ensureAuthorizedSessionForSocketStart());
+    const sockets = new app_1.UserSockets(sessions.ensureAuthorizedSessionForSocketStart(), WS_PING_PERIOD_MILLIS);
     const storageEvents = new server_events_1.ServerEvents(undefined, api.events.all, sockets.socketGetter);
     // give events ipc to both ends
     sockets.addSocketIPC(storageEvents);
@@ -63,10 +63,10 @@ function setWSPart(app, sessions, users) {
     app.addWS(api.wsEventChannel.URL_END, sockets);
 }
 const MAX_CHUNK_SIZE = '0.5mb';
-function setHttpPart(app, setupLoginRoutes, sessions, users) {
+function setHttpPart(app, domain, sessions, users, midAuthorizer) {
     app.disable('etag');
     // Login
-    setupLoginRoutes(app, '/' + api.midLogin.URL_PART);
+    (0, mid_access_1.addMailerIdLoginRoutes)(app, domain, '/' + api.midLogin.URL_PART, sessions, users.exists, midAuthorizer);
     // *** Require authorized session for everything below ***
     app.use(sessions.ensureAuthorizedSession());
     app.post('/' + api.closeSession.URL_END, (0, body_parsers_1.emptyBody)(), (0, close_1.closeSession)());

package/build/asmail/asmail-app.js

@@ -38,9 +38,9 @@ function setupStaticEntryRoute(app) {
             path = path + '/';
         }
         const json = {
-            "delivery": path + PATHS.delivery.substring(1),
-            "retrieval": path + PATHS.retrieval.substring(1),
-            "config": path + PATHS.config.substring(1)
+            delivery: path + PATHS.delivery.substring(1),
+            retrieval: path + PATHS.retrieval.substring(1),
+            config: path + PATHS.config.substring(1)
         };
         // the following implicitly sets content type application/json
         res.status(200).json(json);

package/build/asmail/resources/inbox.d.ts

@@ -75,9 +75,11 @@ export declare class Inbox extends UserFiles<InboxParams> {
     completeMsgDelivery(msgId: string): Promise<void>;
     private areAllMsgObjsComplete;
     /**
+     * @param fromTS
+     * @param toTS
      * @return a promise, resolvable to a list of available message ids.
      */
-    getMsgIds(): Promise<retrievalApi.listMsgs.Reply>;
+    getMsgIds(fromTS: number | undefined, toTS: number | undefined): Promise<retrievalApi.listMsgs.Reply>;
     /**
      * This method returns parameters of an incomplete message, identified
      * by a given id.

package/build/asmail/resources/inbox.js

@@ -237,10 +237,31 @@ class Inbox extends user_files_1.UserFiles {
         return true;
     }
     /**
+     * @param fromTS
+     * @param toTS
      * @return a promise, resolvable to a list of available message ids.
      */
-    getMsgIds() {
-        return fs.readdir(this.metas.readyMsgsFolder);
+    async getMsgIds(fromTS, toTS) {
+        // XXX this isn't efficient, and needs sqlite-powered index
+        const lst = await fs.readdir(this.metas.readyMsgsFolder);
+        if ((fromTS === undefined) && (toTS === undefined)) {
+            return lst;
+        }
+        const filteredLst = [];
+        for (const msgId of lst) {
+            try {
+                const { deliveryStart } = await this.metas.get(msgId, true);
+                if (fromTS && (deliveryStart < fromTS)) {
+                    continue;
+                }
+                if (toTS && (toTS < deliveryStart)) {
+                    continue;
+                }
+                filteredLst.push(msgId);
+            }
+            catch (exc) { }
+        }
+        return filteredLst;
     }
     /**
      * This method returns parameters of an incomplete message, identified

package/build/asmail/resources/recipients.d.ts

@@ -79,7 +79,7 @@ export interface MsgRetrieval {
      * This returns a promise, resolvable to array with ids of available
      * messages. Rejected promise may have a string error code from SC.
      */
-    getMsgIds: (userId: string) => Promise<retrievalApi.listMsgs.Reply>;
+    getMsgIds: (userId: string, fromTS: number | undefined, toTS: number | undefined) => Promise<retrievalApi.listMsgs.Reply>;
     /**
      * This returns a promise, resolvable to message meta.
      * Rejected promise may have a string error code from SC.

package/build/asmail/resources/recipients.js

@@ -284,9 +284,9 @@ function makeRecipients(rootFolder, writeBufferSize, readBufferSize) {
     Object.freeze(delivery);
     const retrieval = {
         exists: config.exists,
-        getMsgIds: async (userId) => {
+        getMsgIds: async (userId, fromTS, toTS) => {
             const inbox = await getInbox(userId);
-            return inbox.getMsgIds();
+            return inbox.getMsgIds(fromTS, toTS);
         },
         getMsgMeta: async (userId, msgId) => {
             const inbox = await getInbox(userId);

package/build/asmail/retrieval.js

@@ -27,6 +27,7 @@ const remove_message_1 = require("./routes/retrieval/remove-message");
 const get_message_obj_1 = require("./routes/retrieval/get-message-obj");
 const api = require("../lib-common/service-api/asmail/retrieval");
 const mid_access_1 = require("../lib-server/mid-access");
+const WS_PING_PERIOD_MILLIS = 2 * 60 * 1000;
 function makeApp(domain, sessions, recipients, midAuthorizer) {
     const app = new app_1.AppWithWSs();
     setHttpPart(app.http, domain, sessions, recipients, midAuthorizer);
@@ -35,9 +36,8 @@ function makeApp(domain, sessions, recipients, midAuthorizer) {
 }
 exports.makeApp = makeApp;
 function setWSPart(app, sessions, recipients) {
-    const sockets = new app_1.UserSockets(sessions.ensureAuthorizedSessionForSocketStart());
-    const mailEvents = new server_events_1.ServerEvents(undefined, [api.msgRecievedCompletely.EVENT_NAME,
-        api.msgMainObjRecieved.EVENT_NAME], sockets.socketGetter);
+    const sockets = new app_1.UserSockets(sessions.ensureAuthorizedSessionForSocketStart(), WS_PING_PERIOD_MILLIS);
+    const mailEvents = new server_events_1.ServerEvents(undefined, [api.msgRecievedCompletely.EVENT_NAME, api.msgMainObjRecieved.EVENT_NAME], sockets.socketGetter);
     // give events ipc to both ends
     sockets.addSocketIPC(mailEvents);
     recipients.setMailEventsSink(mailEvents.eventsSink);
@@ -46,11 +46,11 @@ function setWSPart(app, sessions, recipients) {
 function setHttpPart(app, domain, sessions, recipients, midAuthorizer) {
     app.disable('etag');
     // Login
-    (0, mid_access_1.addMailerIdLoginRoutes)(app, domain, '/' + api.midLogin.URL_PART, sessions, recipients.exists, midAuthorizer);
+    (0, mid_access_1.addMailerIdLoginRoutes)(app, domain, '/' + api.midLogin.MID_URL_PART, sessions, recipients.exists, midAuthorizer);
     // *** Require authorized session for everything below ***
     app.use(sessions.ensureAuthorizedSession());
     app.post('/' + api.closeSession.URL_END, (0, body_parsers_1.emptyBody)(), (0, close_1.closeSession)());
-    app.get('/' + api.listMsgs.URL_END, (0, list_messages_1.listMsgIds)(recipients.getMsgIds));
+    app.get('/' + api.listMsgs.EXPRESS_URL_END, (0, list_messages_1.listMsgIds)(recipients.getMsgIds));
     app.get('/' + api.msgMetadata.EXPRESS_URL_END, (0, get_message_meta_1.getMsgMeta)(recipients.getMsgMeta));
     app.delete('/' + api.rmMsg.EXPRESS_URL_END, (0, remove_message_1.deleteMsg)(recipients.deleteMsg));
     app.get('/' + api.msgObj.EXPRESS_URL_END, (0, get_message_obj_1.getMsgObj)(recipients.getObj));

package/build/asmail/routes/retrieval/list-messages.js

@@ -22,8 +22,14 @@ const retrieval_1 = require("../../../lib-common/service-api/asmail/retrieval");
 function listMsgIds(listMsgIdsFunc) {
     return async (req, res, next) => {
         const userId = req.session.params.userId;
+        const opts = extractQueryOptions(req);
+        if (!opts) {
+            res.status(retrieval_1.ERR_SC.malformed).send("Bad query parameters");
+            return;
+        }
         try {
-            const msgIds = await listMsgIdsFunc(userId);
+            const { from, to } = opts;
+            const msgIds = await listMsgIdsFunc(userId, from, to);
             res.status(retrieval_1.listMsgs.SC.ok).json(msgIds);
         }
         catch (err) {
@@ -41,4 +47,16 @@ function listMsgIds(listMsgIdsFunc) {
     };
 }
 exports.listMsgIds = listMsgIds;
+function extractQueryOptions(req) {
+    const query = req.query;
+    const from = (query.from ? parseInt(query.from) : undefined);
+    if ((from !== undefined) && (isNaN(from) || (from <= 0))) {
+        return;
+    }
+    const to = (query.to ? parseInt(query.to) : undefined);
+    if ((to !== undefined) && (isNaN(to) || (to <= 0))) {
+        return;
+    }
+    return { from, to };
+}
 Object.freeze(exports);

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

@@ -432,9 +432,9 @@ class EventsReceivingSide extends RequestingSide {
          * name, to which listener is attached.
          */
         this.listeners = new map_of_sets_1.MapOfSets();
-        this.channels = new IpcEventChannels((ipcChannel) => this.makeRequest(ipc_api_1.events.subscribe.REQ_NAME, ipcChannel)
-            .catch(err => this.completeEvent(ipcChannel, err)), (ipcChannel) => this.makeRequest(ipc_api_1.events.unsubscribe.REQ_NAME, ipcChannel)
-            .catch(err => { }));
+        this.channels = new IpcEventChannels(ipcChannel => this.makeRequest(ipc_api_1.events.subscribe.REQ_NAME, ipcChannel)
+            .catch(err => this.completeEvent(ipcChannel, err)), ipcChannel => this.makeRequest(ipc_api_1.events.unsubscribe.REQ_NAME, ipcChannel)
+            .catch(noop));
     }
     handleMsg(env) {
         if (env.type === 'event') {
@@ -581,6 +581,7 @@ class IpcEventChannels {
 }
 Object.freeze(IpcEventChannels.prototype);
 Object.freeze(IpcEventChannels);
+function noop() { }
 function makeSubscribingClient(channel, comm) {
     return (new EventsReceivingSide(channel, comm)).wrap();
 }

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

@@ -0,0 +1,5 @@
+export interface StorageRootRoute {
+    owner?: string;
+    shared?: string;
+    config?: string;
+}

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

@@ -0,0 +1,18 @@
+"use strict";
+/*
+ Copyright (C) 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
+ 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 });

package/build/lib-common/service-api/asmail/retrieval.d.ts

@@ -12,13 +12,20 @@ export declare const ERR_SC: {
     server: number;
 };
 export declare namespace midLogin {
-    const URL_PART = "login/mailerid/";
+    const MID_URL_PART = "login/mailerid/";
+    const START_URL_END: string;
+    const AUTH_URL_END: string;
 }
 export declare namespace closeSession {
     const URL_END = "close-session";
 }
+export interface ListMsgsOpts {
+    from?: number;
+    to?: number;
+}
 export declare namespace listMsgs {
-    const URL_END = "msg/ids";
+    const EXPRESS_URL_END = "msg/ids";
+    function genUrlEnd(opts?: ListMsgsOpts): string;
     interface Reply extends Array<string> {
     }
     const SC: {
@@ -35,7 +42,7 @@ export declare namespace rmMsg {
 }
 export interface ObjSize {
     header: number;
-    segments: number;
+    segments: number | undefined;
 }
 export interface ObjStatus {
     completed?: boolean;

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

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015, 2017 3NSoft Inc.
+ Copyright (C) 2015, 2017, 2019, 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
@@ -13,8 +13,7 @@
  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 program. If not, see <http://www.gnu.org/licenses/>. */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.msgMainObjRecieved = exports.msgRecievedCompletely = exports.wsEventChannel = exports.msgObj = exports.sanitizedMeta = exports.msgMetadata = exports.rmMsg = exports.listMsgs = exports.closeSession = exports.midLogin = exports.ERR_SC = exports.HTTP_HEADER = exports.BIN_TYPE = void 0;
 /**
@@ -38,7 +37,9 @@ exports.ERR_SC = {
 Object.freeze(exports.ERR_SC);
 var midLogin;
 (function (midLogin) {
-    midLogin.URL_PART = 'login/mailerid/';
+    midLogin.MID_URL_PART = 'login/mailerid/';
+    midLogin.START_URL_END = midLogin.MID_URL_PART + midApi.startSession.URL_END;
+    midLogin.AUTH_URL_END = midLogin.MID_URL_PART + midApi.authSession.URL_END;
 })(midLogin = exports.midLogin || (exports.midLogin = {}));
 Object.freeze(midLogin);
 var closeSession;
@@ -48,7 +49,12 @@ var closeSession;
 Object.freeze(closeSession);
 var listMsgs;
 (function (listMsgs) {
-    listMsgs.URL_END = 'msg/ids';
+    listMsgs.EXPRESS_URL_END = 'msg/ids';
+    function genUrlEnd(opts) {
+        let optStr = (opts ? '?' + (0, querystring_1.stringify)(opts) : '');
+        return `msg/ids${optStr}`;
+    }
+    listMsgs.genUrlEnd = genUrlEnd;
     listMsgs.SC = {
         ok: 200,
     };
@@ -144,4 +150,7 @@ var msgMainObjRecieved;
     msgMainObjRecieved.EVENT_NAME = 'msg-main-obj-received';
 })(msgMainObjRecieved = exports.msgMainObjRecieved || (exports.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/build/lib-common/service-api/asmail/root-route.d.ts

@@ -0,0 +1,5 @@
+export interface ASMailRootRoute {
+    delivery?: string;
+    retrieval?: string;
+    config?: string;
+}

package/build/lib-common/service-api/asmail/root-route.js

@@ -0,0 +1,18 @@
+"use strict";
+/*
+ Copyright (C) 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
+ 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 });

package/build/lib-common/service-api/mailer-id/root-route.d.ts

@@ -0,0 +1,6 @@
+import { SignedLoad } from "../../jwkeys";
+export interface MailerIdRootRoute {
+    "current-cert": SignedLoad;
+    "previous-certs": SignedLoad[];
+    provisioning: string;
+}

package/build/lib-common/service-api/mailer-id/root-route.js

@@ -0,0 +1,18 @@
+"use strict";
+/*
+ Copyright (C) 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
+ 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 });

package/build/lib-server/web-sockets/app.d.ts

@@ -8,13 +8,14 @@ import { CheckSession, SessionParams } from '../resources/sessions';
 export type HttpServer = http.Server | https.Server;
 export declare class UserSockets {
     checkSession: CheckSession<SessionParams>;
+    private readonly pingMillis;
     /**
      * Only connections that match this path are accepted.
      */
     path: string;
     private clients;
     private ipcs;
-    constructor(checkSession: CheckSession<SessionParams>);
+    constructor(checkSession: CheckSession<SessionParams>, pingMillis: number);
     disconnect(): void;
     handleConnection(userId: string, client: WebSocket): void;
     addSocketIPC(ipc: SocketIPCs): void;

package/build/lib-server/web-sockets/app.js

@@ -124,8 +124,9 @@ function ensureSlashesOnFront(path) {
     return path;
 }
 class UserSockets {
-    constructor(checkSession) {
+    constructor(checkSession, pingMillis) {
         this.checkSession = checkSession;
+        this.pingMillis = pingMillis;
         /**
          * Only connections that match this path are accepted.
          */
@@ -140,7 +141,7 @@ class UserSockets {
         for (const ipc of this.ipcs) {
             ipc.attachIPC(userId, client);
         }
-        let pinger = new PingSender(client);
+        let pinger = new PingSender(client, this.pingMillis);
         client.on('close', () => {
             this.clients.remove(userId, client);
             pinger.close();
@@ -162,10 +163,12 @@ exports.UserSockets = UserSockets;
 Object.freeze(UserSockets.prototype);
 Object.freeze(UserSockets);
 class PingSender {
-    constructor(client) {
+    constructor(client, pingMillis) {
+        this.pingMillis = pingMillis;
         this.outstandingPong = 0;
         this.client = client;
-        this.fourMinCheck = setInterval(() => this.recurrentPing(), 4 * 60 * 1000);
+        this.pongTimeoutMillis = Math.round(this.pingMillis / 2);
+        this.fourMinCheck = setInterval(() => this.recurrentPing(), this.pingMillis);
         this.fourMinCheck.unref();
     }
     recurrentPing() {
@@ -175,7 +178,7 @@ class PingSender {
         if (this.outstandingPong === 0) {
         }
         else if (this.outstandingPong === 1) {
-            setTimeout(() => this.additionalPing(), 2 * 60 * 1000).unref();
+            setTimeout(() => this.additionalPing(), this.pongTimeoutMillis).unref();
         }
         else {
             this.client.close();

package/build/mailerId/mailerId-app.js

@@ -59,7 +59,7 @@ function makeMailerIdApp(rootFolder, domain, certFile, errLogger) {
         const json = {
             "current-cert": certifier.getRootCert(),
             "previous-certs": certifier.getPrevCerts(),
-            "provisioning": path + PROVISIONING_PATH.substring(1)
+            provisioning: path + PROVISIONING_PATH.substring(1)
         };
         res.status(200).json(json); // content type application/json
     });

package/build/services.d.ts

@@ -7,6 +7,8 @@ export interface Configurations {
         asmail?: boolean;
         storage?: boolean;
         mailerId?: boolean;
+    };
+    auxiliaryServices?: {
         locker?: boolean;
     };
     servicesConnect?: {

package/build/services.js

@@ -26,6 +26,7 @@ const signup_app_1 = require("./signup/signup-app");
 const error_handler_1 = require("./lib-server/middleware/error-handler");
 const locker_app_1 = require("./locker/locker-app");
 function servicesApp(conf, errLogger, logSetup) {
+    var _a;
     if (!conf.enabledServices || (typeof conf.enabledServices !== 'object')) {
         throw new Error('Missing enabled-services sections in confs.');
     }
@@ -54,7 +55,7 @@ function servicesApp(conf, errLogger, logSetup) {
             console.log(`Enabled 3NStorage service with provider domain ${conf.domain}`);
         }
     }
-    if (conf.enabledServices.locker) {
+    if ((_a = conf.auxiliaryServices) === null || _a === void 0 ? void 0 : _a.locker) {
         app.use('/locker', (0, locker_app_1.makeLockerApp)(conf.rootFolder, (errLogger === 'console') ? (0, error_handler_1.makeErrLoggerToConsole)('Locker') : errLogger));
         if (logSetup === 'console') {
             console.log(`Enabled Locker service`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-3nweb-server",
-  "version": "1.7.14",
+  "version": "1.8.1",
   "description": "3NWeb spec server.",
   "main": "build/lib.js",
   "types": "build/lib.d.ts",