core-3nweb-client-lib 0.42.12 → 0.42.14

package/build/lib-client/service-checks.d.ts

@@ -0,0 +1,18 @@
+import { NetClient } from "./request-utils";
+export interface Check {
+    service: 'signup' | 'asmail' | '3nstorage' | 'mailerid';
+}
+export interface CheckStart extends Check {
+    start: true;
+    userDomain?: string;
+    serviceUrl?: string;
+}
+export interface CheckResult extends Check {
+    isOk: boolean;
+    userDomains?: string[];
+    userDomain?: string;
+    serviceUrl?: string;
+    message: string;
+    err?: any;
+}
+export declare function checkServicesStartingFromSignup(client: NetClient, signupUrl: string, signupToken: string | undefined, progress?: (result: CheckResult | CheckStart) => void): Promise<CheckResult[]>;

package/build/lib-client/service-checks.js

@@ -0,0 +1,177 @@
+"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 });
+exports.checkServicesStartingFromSignup = checkServicesStartingFromSignup;
+const _3nweb_signup_1 = require("./3nweb-signup");
+const service_locator_1 = require("./service-locator");
+const dns_1 = require("dns");
+async function checkServicesStartingFromSignup(client, signupUrl, signupToken, progress) {
+    const results = [];
+    function recordResult(r) {
+        progress === null || progress === void 0 ? void 0 : progress(r);
+        results.push(r);
+    }
+    progress === null || progress === void 0 ? void 0 : progress({ start: true, service: 'signup', serviceUrl: signupUrl });
+    const signupCheck = await checkSignup(client, signupUrl, signupToken);
+    recordResult(signupCheck);
+    if (!signupCheck.isOk) {
+        return results;
+    }
+    async function checkService(service, userDomain) {
+        progress === null || progress === void 0 ? void 0 : progress({ start: true, service, userDomain });
+        const check = await checkUserDomainDNS(service, userDomain);
+        recordResult(check);
+        if (check.isOk) {
+            await checkFstServiceEndpoint(service, check.serviceUrl);
+        }
+    }
+    async function checkFstServiceEndpoint(service, serviceUrl) {
+        progress === null || progress === void 0 ? void 0 : progress({ start: true, service: 'mailerid', serviceUrl });
+        try {
+            if (service === 'mailerid') {
+                await (0, service_locator_1.mailerIdInfoAt)(client, serviceUrl);
+            }
+            else if (service === 'asmail') {
+                await (0, service_locator_1.asmailInfoAt)(client, serviceUrl);
+            }
+            else if (service === '3nstorage') {
+                await (0, service_locator_1.storageInfoAt)(client, serviceUrl);
+            }
+            else {
+                throw new Error(`Unknown service ${service}`);
+            }
+            recordResult({
+                isOk: true, service, serviceUrl,
+                message: `Main ${service} entrypoint at ${serviceUrl} works.`
+            });
+        }
+        catch (err) {
+            let message = '';
+            if (err.type === 'connect') {
+                message = `Fail to connect to ${service} service as ${serviceUrl}:
+- there may be no connection,
+- service might be not up or misconfigured.`;
+            }
+            recordResult({ service, isOk: false, serviceUrl, err, message });
+        }
+    }
+    for (const domain of signupCheck.userDomains) {
+        await checkService('mailerid', domain);
+        await checkService('asmail', domain);
+        await checkService('3nstorage', domain);
+    }
+    return results;
+}
+async function checkSignup(client, signupURL, signupToken) {
+    try {
+        const domains = await (0, _3nweb_signup_1.checkAvailableDomains)(client, signupURL, signupToken);
+        if (domains.length === 0) {
+            return {
+                service: 'signup',
+                isOk: false,
+                message: `Signup service responds but gives no domains:
+- token can be incorrect/missing,
+- service might have no user domains set up for signup.`
+            };
+        }
+        else {
+            return {
+                service: 'signup',
+                isOk: true,
+                userDomains: domains,
+                message: `Signup service returns domain(s) for users: ${domains.join(', ')}.`
+            };
+        }
+    }
+    catch (err) {
+        let message = '';
+        if (err.type === 'http-request') {
+            if (err.status === 404) {
+                message = `Server doesn't recognize path in url:
+- service url might be incorrect,
+- signup service might be not set up on given url.`;
+            }
+            else {
+                message = `Server produces non-ok response, ${err.status}:
+- service url might be incorrect,
+- signup service might be not set up on given url.`;
+            }
+        }
+        else if (err.type === 'connect') {
+            message = `Fail to connect to signup service:
+- there may be no connection,
+- service url might be incorrect,
+- server might be not set up, or not connected.`;
+        }
+        return {
+            service: 'signup',
+            isOk: false,
+            err,
+            message
+        };
+    }
+}
+const srvLocator = (0, service_locator_1.makeServiceLocator)({
+    resolveTxt: domain => new Promise((resolve, reject) => (0, dns_1.resolveTxt)(domain, (err, texts) => {
+        if (err) {
+            reject(err);
+        }
+        else {
+            resolve(texts);
+        }
+    }))
+});
+async function checkUserDomainDNS(service, domain) {
+    try {
+        const serviceUrl = await (srvLocator(service))(`u@${domain}`);
+        return {
+            service,
+            isOk: true,
+            serviceUrl,
+            message: `DNS record for domain ${domain} says that ${service} service is expected to be at ${serviceUrl}`
+        };
+    }
+    catch (err) {
+        let message = '';
+        if (err.type === 'connect') {
+            message = `Fail to connect to get DNS record:
+- there may be no connection,
+- there may be DNS misconfiguration.`;
+        }
+        else if (err.type === 'service-locating') {
+            if (err.domainNotFound) {
+                message = `User domain ${domain} not found:
+- domain might be incorrect
+- there may be DNS misconfiguration.`;
+            }
+            else if (err.noServiceRecord) {
+                message = `User domain ${domain} doesn't have record for ${service} service:
+- domain might be incorrect
+- there may be DNS misconfiguration.`;
+            }
+        }
+        return {
+            service,
+            isOk: false,
+            userDomain: domain,
+            err,
+            message
+        };
+    }
+}
+Object.freeze(exports);

package/build/lib-index.d.ts

@@ -12,3 +12,4 @@ export { sysFolders } from "./core/storage/system-folders";
 export { DeviceFS } from './lib-client/local-files/device-fs';
 export { makeLogger } from './lib-client/logging/log-to-file';
 export declare const SYSTEM_DOMAIN = "3nweb.computer";
+export { checkServicesStartingFromSignup } from './lib-client/service-checks';

package/build/lib-index.js

@@ -30,7 +30,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SYSTEM_DOMAIN = exports.makeLogger = exports.DeviceFS = exports.sysFolders = exports.appDirs = exports.makeNetClient = exports.makeServiceLocator = exports.ASMail = exports.SignIn = exports.reverseDomain = exports.Storages = exports.IdManager = exports.SignUp = void 0;
+exports.checkServicesStartingFromSignup = exports.SYSTEM_DOMAIN = exports.makeLogger = exports.DeviceFS = exports.sysFolders = exports.appDirs = exports.makeNetClient = exports.makeServiceLocator = exports.ASMail = exports.SignIn = exports.reverseDomain = exports.Storages = exports.IdManager = exports.SignUp = void 0;
 __exportStar(require("./core"), exports);
 var sign_up_1 = require("./core/startup/sign-up");
 Object.defineProperty(exports, "SignUp", { enumerable: true, get: function () { return sign_up_1.SignUp; } });
@@ -56,4 +56,6 @@ Object.defineProperty(exports, "DeviceFS", { enumerable: true, get: function ()
 var log_to_file_1 = require("./lib-client/logging/log-to-file");
 Object.defineProperty(exports, "makeLogger", { enumerable: true, get: function () { return log_to_file_1.makeLogger; } });
 exports.SYSTEM_DOMAIN = '3nweb.computer';
+var service_checks_1 = require("./lib-client/service-checks");
+Object.defineProperty(exports, "checkServicesStartingFromSignup", { enumerable: true, get: function () { return service_checks_1.checkServicesStartingFromSignup; } });
 Object.freeze(exports);

package/package.json

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