spec-3nweb-server 1.8.12 → 1.9.1

package/build/lib.d.ts

@@ -1,5 +1,5 @@
 export { AppWithWSs } from './lib-server/web-sockets/app';
-export { Configurations, servicesApp, accountsApp } from './services';
+export { Configurations, servicesApp, accountsApp, wellKnownApp } from './services';
 export { addSingleUserSignup } from './config/signup';
 export import errors = require('./lib-server/middleware/error-handler');
 export * as mock from './mock/run-in-proc';

package/build/lib.js

@@ -16,12 +16,13 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mock = exports.addSingleUserSignup = exports.accountsApp = exports.servicesApp = exports.AppWithWSs = void 0;
+exports.mock = exports.addSingleUserSignup = exports.wellKnownApp = exports.accountsApp = exports.servicesApp = exports.AppWithWSs = void 0;
 var app_1 = require("./lib-server/web-sockets/app");
 Object.defineProperty(exports, "AppWithWSs", { enumerable: true, get: function () { return app_1.AppWithWSs; } });
 var services_1 = require("./services");
 Object.defineProperty(exports, "servicesApp", { enumerable: true, get: function () { return services_1.servicesApp; } });
 Object.defineProperty(exports, "accountsApp", { enumerable: true, get: function () { return services_1.accountsApp; } });
+Object.defineProperty(exports, "wellKnownApp", { enumerable: true, get: function () { return services_1.wellKnownApp; } });
 var signup_1 = require("./config/signup");
 Object.defineProperty(exports, "addSingleUserSignup", { enumerable: true, get: function () { return signup_1.addSingleUserSignup; } });
 exports.errors = require("./lib-server/middleware/error-handler");

package/build/main.js

@@ -36,6 +36,7 @@ async function run(conf) {
         const app = new lib_1.AppWithWSs();
         app.use((0, lib_1.servicesApp)(conf, 'console', 'console'));
         app.use((0, lib_1.accountsApp)(conf, 'console', 'console'));
+        app.use((0, lib_1.wellKnownApp)(conf));
         return app;
     }
     async function stopProcess() {
@@ -61,7 +62,7 @@ async function run(conf) {
     }
     async function startAppWithoutTLS(port, hostname) {
         await app.start(undefined, port, hostname);
-        console.log(`🚀 Started 3NWeb server on port ${port},${hostname ? ` hostname ${hostname},` : ''} without TLS, and requiring TLS reverse proxy infront.`);
+        console.log(`🚀 Started 3NWeb server on port ${port},${hostname ? ` hostname ${hostname},` : ''} without TLS, and requiring TLS or Tor-like reverse proxy infront.`);
     }
     try {
         app = createApp(conf);

package/build/services.d.ts

@@ -27,6 +27,12 @@ export interface Configurations {
         noTokenFile?: string;
         serviceUrl?: string;
     };
+    wellKnown3NWeb?: {
+        mailerid?: string;
+        asmail?: string;
+        "3nstorage"?: string;
+    };
 }
 export declare function servicesApp(conf: Configurations, errLogger?: ErrLogger | 'console', logSetup?: 'console'): AppWithWSs;
 export declare function accountsApp(conf: Configurations, errLogger?: ErrLogger | 'console', logSetup?: 'console'): AppWithWSs;
+export declare function wellKnownApp(conf: Configurations): AppWithWSs;

package/build/services.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2017, 2020, 2024 - 2025 3NSoft Inc.
+ Copyright (C) 2015 - 2017, 2020, 2024 - 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
@@ -16,7 +16,7 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.accountsApp = exports.servicesApp = void 0;
+exports.wellKnownApp = exports.accountsApp = exports.servicesApp = void 0;
 const mailerid_authorizer_1 = require("./lib-server/resources/mailerid-authorizer");
 const app_1 = require("./lib-server/web-sockets/app");
 const mailerId_app_1 = require("./mailerId/mailerId-app");
@@ -25,6 +25,7 @@ const _3nstorage_app_1 = require("./3nstorage/3nstorage-app");
 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");
+const well_known_route_app_1 = require("./well-known/well-known-route-app");
 function servicesApp(conf, errLogger, logSetup) {
     var _a;
     if (!conf.enabledServices || (typeof conf.enabledServices !== 'object')) {
@@ -75,4 +76,12 @@ function accountsApp(conf, errLogger, logSetup) {
     return app;
 }
 exports.accountsApp = accountsApp;
+function wellKnownApp(conf) {
+    const app = new app_1.AppWithWSs();
+    if (conf.wellKnown3NWeb) {
+        app.http.use('/.well-known', (0, well_known_route_app_1.makeWellKnownApp)(conf.wellKnown3NWeb));
+    }
+    return app;
+}
+exports.wellKnownApp = wellKnownApp;
 Object.freeze(exports);

package/build/well-known/well-known-route-app.d.ts

@@ -0,0 +1,3 @@
+import * as express from 'express';
+import { Configurations } from '../services';
+export declare function makeWellKnownApp(w3n: NonNullable<Configurations['wellKnown3NWeb']>): express.Application;

package/build/well-known/well-known-route-app.js

@@ -0,0 +1,53 @@
+"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.makeWellKnownApp = void 0;
+const express = require("express");
+function makeWellKnownApp(w3n) {
+    const app = express();
+    const w3nJson = confTo3NWebJSON(w3n);
+    app.get('3nweb.json', (req, res) => {
+        // the following implicitly sets content type application/json
+        res.status(200).json(w3nJson);
+    });
+    return app;
+}
+exports.makeWellKnownApp = makeWellKnownApp;
+function confTo3NWebJSON(conf) {
+    const json = {};
+    const fields = ['3nstorage', 'asmail', 'mailerid'];
+    for (const field in fields) {
+        const href = conf[field];
+        if (href) {
+            let u;
+            try {
+                u = new URL(href);
+            }
+            catch (err) {
+                console.error(` ❌  Configuration field ${field} for well-known needs potocol section`);
+                throw err;
+            }
+            if ((u.protocol !== 'https:') && (u.protocol !== 'http:')) {
+                throw new Error(` ❌  Configuration field ${field} for well-known needs potocol section`);
+            }
+            json[field] = href;
+        }
+    }
+    return json;
+}
+Object.freeze(exports);

package/package.json

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

package/ts-code/lib.ts

@@ -17,7 +17,7 @@
 
 export { AppWithWSs } from './lib-server/web-sockets/app';
 
-export { Configurations, servicesApp, accountsApp } from './services';
+export { Configurations, servicesApp, accountsApp, wellKnownApp } from './services';
 
 export { addSingleUserSignup } from './config/signup';
 

package/ts-code/main.ts

@@ -25,7 +25,7 @@ import { ServerOptions } from 'https';
 import { CliUsageDisplay, parseProcessArgv } from './cli';
 import { readYamlConfFile } from './config/from-yaml';
 import { sslOptsFromConfig } from './config/letsencrypt';
-import { Configurations, servicesApp, accountsApp, AppWithWSs } from './lib';
+import { Configurations, servicesApp, accountsApp, AppWithWSs, wellKnownApp } from './lib';
 import { addMultiDomainSignup, addSingleUserSignup, readAllSignupTokens, readNoTokensFile, readTokenFile } from './config/signup';
 import { DEFAULT_CONFIG_PATH } from './config/default-confs';
 import { Code } from './lib-common/exceptions/file';
@@ -45,6 +45,7 @@ async function run(conf: Configurations): Promise<void> {
 		const app = new AppWithWSs();
 		app.use(servicesApp(conf, 'console', 'console'));
 		app.use(accountsApp(conf, 'console', 'console'));
+		app.use(wellKnownApp(conf));
 		return app;
 	}
 
@@ -73,7 +74,7 @@ async function run(conf: Configurations): Promise<void> {
 		port: number, hostname: string|undefined
 	): Promise<void> {
 		await app!.start(undefined, port, hostname);
-		console.log(`🚀 Started 3NWeb server on port ${port},${hostname ? ` hostname ${hostname},` : ''} without TLS, and requiring TLS reverse proxy infront.`);	
+		console.log(`🚀 Started 3NWeb server on port ${port},${hostname ? ` hostname ${hostname},` : ''} without TLS, and requiring TLS or Tor-like reverse proxy infront.`);
 	}
 
 	try {

package/ts-code/services.ts

@@ -1,5 +1,5 @@
 /*
- Copyright (C) 2015 - 2017, 2020, 2024 - 2025 3NSoft Inc.
+ Copyright (C) 2015 - 2017, 2020, 2024 - 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
@@ -30,6 +30,7 @@ import { makeSignupApp } from './signup/signup-app';
 import { ErrLogger, makeErrLoggerToConsole } from "./lib-server/middleware/error-handler";
 import { makeLockerApp } from "./locker/locker-app";
 import { MidAuthorizer } from "./lib-server/routes/sessions/mid-auth";
+import { makeWellKnownApp } from "./well-known/well-known-route-app";
 
 export interface Configurations {
 	enabledServices: {
@@ -56,6 +57,11 @@ export interface Configurations {
 		noTokenFile?: string;
 		serviceUrl?: string;
 	};
+	wellKnown3NWeb?: {
+		mailerid?: string;
+		asmail?: string;
+		"3nstorage"?: string;
+	};
 }
 
 export function servicesApp(
@@ -135,4 +141,15 @@ export function accountsApp(
 	return app;
 }
 
+export function wellKnownApp(conf: Configurations): AppWithWSs {
+
+	const app = new AppWithWSs();
+
+	if (conf.wellKnown3NWeb) {
+		app.http.use('/.well-known', makeWellKnownApp(conf.wellKnown3NWeb));
+	}
+
+	return app;
+}
+
 Object.freeze(exports);

package/ts-code/well-known/well-known-route-app.ts

@@ -0,0 +1,66 @@
+/*
+ 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/>.
+*/
+
+import * as express from 'express';
+import { Configurations } from '../services';
+
+export function makeWellKnownApp(w3n: NonNullable<Configurations['wellKnown3NWeb']>): express.Application {
+
+	const app = express();
+
+	const w3nJson = confTo3NWebJSON(w3n);
+
+	app.get('3nweb.json', (req, res) => {
+		// the following implicitly sets content type application/json
+		res.status(200).json(w3nJson);
+	});
+
+	return app;
+}
+
+interface WellKnown3NWeb {
+  mailerid?: string;
+  asmail?: string;
+  '3nstorage'?: string;
+  report?: string;
+  'w3n-app'?: string;
+}
+
+function confTo3NWebJSON(conf: NonNullable<Configurations['wellKnown3NWeb']>): WellKnown3NWeb {
+	const json: WellKnown3NWeb = {};
+	const fields: (keyof WellKnown3NWeb)[] = [ '3nstorage', 'asmail', 'mailerid' ];
+	for (const field in fields) {
+		const href = conf[field];
+		if (href) {
+			let u: URL;
+			try {
+				u = new URL(href);
+			} catch (err) {
+				console.error(` ❌  Configuration field ${field} for well-known needs potocol section`);
+				throw err;
+			}
+			if ((u.protocol !== 'https:') && (u.protocol !== 'http:')) {
+				throw new Error(` ❌  Configuration field ${field} for well-known needs potocol section`);
+			}
+			json[field] = href;
+		}
+	}
+	return json;
+}
+
+
+Object.freeze(exports);