core-3nweb-client-lib 0.44.11 → 0.45.0

package/build/tests/caps-api/fs-checks/with-core-restarts/xattrs.js

@@ -0,0 +1,50 @@
+"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.specs = void 0;
+const random_node_1 = require("../../../../lib-common/random-node");
+exports.specs = {
+    description: '--',
+    its: []
+};
+let it = {
+    expectation: 'reading and writing file with xattrs'
+};
+it.func = async function ({ dev1FS, dev2, dev2FS }) {
+    const file = `file-with-xattrs`;
+    const fileContent = (0, random_node_1.stringOfB64CharsSync)(100);
+    const xattrValue = {
+        "string-attr": 'blah, blah',
+        "empty-string-attr": '',
+        "number-attr": 42
+    };
+    await dev2FS().writeTxtFile(file, fileContent);
+    await dev2FS().updateXAttrs(file, { set: xattrValue });
+    await dev2FS().v.sync.upload(file);
+    await dev2FS().v.sync.upload('');
+    // Let's read file on another device
+    await dev1FS().v.sync.status('');
+    await dev1FS().v.sync.adoptRemote('');
+    expect(await dev1FS().readTxtFile(file)).toBe(fileContent);
+    // Let's read file on original device after restart
+    await dev2.stop();
+    await dev2.start();
+    expect(await dev2FS().readTxtFile(file)).toBe(fileContent);
+};
+exports.specs.its.push(it);
+Object.freeze(exports);

package/build/tests/caps-api/keyrings.js

@@ -0,0 +1,69 @@
+"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 });
+const jasmine_utils_1 = require("../libs-for-tests/jasmine-utils");
+const setups_1 = require("../libs-for-tests/setups");
+const assert_1 = require("../../lib-common/assert");
+const jwkeys_1 = require("../../lib-common/jwkeys");
+const canonical_address_1 = require("../../lib-common/canonical-address");
+const json_utils_1 = require("../../lib-common/json-utils");
+describe('keyrings', () => {
+    const userAddr = 'Bob Perkins @company.inc';
+    const s = (0, setups_1.setupWithUsers)(true, [userAddr]);
+    let keyrings;
+    let asmailConfig;
+    beforeAll(() => {
+        (0, assert_1.assert)(s.users.length >= 1, `at least one user should be set up`);
+        const w3n = s.testAppCapsByUserIndex(0);
+        keyrings = w3n.keyrings;
+        asmailConfig = w3n.mail.config;
+    });
+    (0, jasmine_utils_1.itCond)(`can view and update intro key on server`, async () => {
+        // intro key CAP in this test
+        const pkeyCAP = keyrings.introKeyOnASMailServer;
+        // see key that should be currently on server
+        const fstCert = await pkeyCAP.getCurrent();
+        expect(fstCert).toBeTruthy();
+        expect((0, canonical_address_1.areAddressesEqual)(userAddr, (0, jwkeys_1.getPrincipalAddress)(fstCert.pkeyCert))).toBeTrue();
+        expect((0, json_utils_1.deepEqual)(fstCert, await asmailConfig.getOnServer('init-pub-key'))).toBeTrue();
+        const fstKid = (0, jwkeys_1.getPubKey)(fstCert.pkeyCert);
+        // removing intro key from ASMail server
+        await pkeyCAP.remove();
+        expect(await pkeyCAP.getCurrent()).toBeNull();
+        expect(await asmailConfig.getOnServer('init-pub-key')).toBeNull();
+        // second removal is a noop
+        await pkeyCAP.remove();
+        expect(await pkeyCAP.getCurrent()).toBeNull();
+        expect(await asmailConfig.getOnServer('init-pub-key')).toBeNull();
+        // update makes and publishes new keys
+        const sndKey = await pkeyCAP.makeAndPublishNew();
+        expect(sndKey).toBeTruthy();
+        const sndKid = (0, jwkeys_1.getPubKey)(sndKey.pkeyCert);
+        expect(sndKid).not.toBe(fstKid);
+        expect((0, json_utils_1.deepEqual)(sndKey, await asmailConfig.getOnServer('init-pub-key'))).toBeTrue();
+        const thirdKey = await pkeyCAP.makeAndPublishNew();
+        expect(thirdKey).toBeTruthy();
+        const thirdKid = (0, jwkeys_1.getPubKey)(thirdKey.pkeyCert);
+        expect(thirdKid).not.toBe(fstKid);
+        expect(thirdKid).not.toBe(sndKid);
+        expect((0, json_utils_1.deepEqual)(thirdKey, await asmailConfig.getOnServer('init-pub-key'))).toBeTrue();
+    }, undefined, s);
+    (0, jasmine_utils_1.itCond)(`has method to view correpondent's keys info`, async () => {
+        expect(typeof keyrings.getCorrespondentKeys).toBe('function');
+    });
+});

package/build/tests/caps-api/mailerid.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/caps-api/mailerid.js

@@ -0,0 +1,59 @@
+"use strict";
+/*
+ Copyright (C) 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
+ 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 });
+const jasmine_utils_1 = require("../libs-for-tests/jasmine-utils");
+const setups_1 = require("../libs-for-tests/setups");
+const assert_1 = require("../../lib-common/assert");
+const buffer_utils_1 = require("../../lib-common/buffer-utils");
+describe('MailerId', () => {
+    const s = (0, setups_1.setupWithUsers)(true, ['Bob Perkins @company.inc']);
+    const srv = (0, setups_1.serviceWithMailerIdLogin)();
+    let user;
+    let w3n;
+    beforeAll(() => {
+        (0, assert_1.assert)(s.users.length >= 1, `at least one user should be set up`);
+        user = s.users[0];
+        w3n = s.testAppCapsByUser(user);
+    });
+    (0, jasmine_utils_1.itCond)('gets current user id', async () => {
+        const userId = await w3n.mailerid.getUserId();
+        expect(userId).toBe(user.userId);
+    }, undefined, s);
+    (0, jasmine_utils_1.itCond)('performs MailerId login', async () => {
+        const sessionId = await w3n.mailerid.login(srv.serviceUrl);
+        expect(await srv.isSessionValid(sessionId)).toBe(true);
+    }, undefined, s);
+    (0, jasmine_utils_1.itCond)('signs and checks MailerId signatures', async () => {
+        const payloadAsObj = {
+            some: '1234324',
+            fields: 123
+        };
+        const payloadBytes = buffer_utils_1.utf8.pack(JSON.stringify(payloadAsObj));
+        const sig = await w3n.mailerid.sign(payloadBytes);
+        expect(sig.signature.load).toBe(buffer_utils_1.base64.pack(payloadBytes));
+        // check good signature
+        const check1 = await w3n.mailerid.verifySignature(sig);
+        expect(check1.cryptoCheck).toBeTrue();
+        expect(check1.midProviderCheck).toBe('all-ok');
+        // and messed up signature
+        sig.signature.load = sig.signature.load.substring(4);
+        const check2 = await w3n.mailerid.verifySignature(sig);
+        expect(check2.cryptoCheck).toBeFalse();
+        expect(check2.midProviderCheck).toBeUndefined();
+    });
+});

package/build/tests/caps-api/startup/signin-empty-cache.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/caps-api/startup/signin-empty-cache.js

@@ -0,0 +1,108 @@
+"use strict";
+/*
+ Copyright (C) 2016 - 2018, 2020, 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
+ 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 });
+const jasmine_utils_1 = require("../../libs-for-tests/jasmine-utils");
+const setups_1 = require("../../libs-for-tests/setups");
+const startup_1 = require("../../libs-for-tests/startup");
+const core_runner_1 = require("../../libs-for-tests/core-runner");
+const sleep_1 = require("../../../lib-common/processes/sleep");
+const random_node_1 = require("../../../lib-common/random-node");
+// NOTE: it-specs inside signIn process expect to run in a given order -- they
+//		change app's state, expected by following specs in this describe.
+describe('signIn process (empty cache)', () => {
+    const s = (0, setups_1.setupWithUsers)();
+    let user;
+    let w3n;
+    let coreInit;
+    let coreAppsInit;
+    let closeIPC;
+    (0, jasmine_utils_1.beforeAllWithTimeoutLog)(async () => {
+        if (!s.isUp) {
+            return;
+        }
+        user = s.users[0];
+        const runner = s.runners.get(user.userId);
+        await (0, sleep_1.sleep)(3000); // attempt to let processes settle
+        await runner.restart(true, false);
+        ({ closeIPC, coreInit, coreAppsInit, w3n } = runner.startCore());
+    }, 30000);
+    (0, jasmine_utils_1.afterAllCond)(async () => {
+        closeIPC();
+    });
+    (0, jasmine_utils_1.itCond)('has no users on disk', async () => {
+        const users = await w3n.signIn.getUsersOnDisk();
+        expect(Array.isArray(users)).toBe(true);
+        expect(users.length).toBe(0);
+    });
+    (0, jasmine_utils_1.itCond)(`fails for user id with wrong domain`, async () => {
+        try {
+            const unknownId = user.userId + (0, random_node_1.stringOfB64UrlSafeCharsSync)(20);
+            await w3n.signIn.startLoginToRemoteStorage(unknownId);
+            fail(`Case with bad domain should throw an exception`);
+        }
+        catch (exc) {
+            expect(exc.runtimeException).toBe(true);
+            expect(exc.cause).toBeTruthy();
+        }
+    });
+    (0, jasmine_utils_1.itCond)(`fails MailerId provisioning with unknown user id`, async () => {
+        const unknownId = (0, random_node_1.stringOfB64UrlSafeCharsSync)(20) + user.userId;
+        const userExists = await w3n.signIn.startLoginToRemoteStorage(unknownId);
+        expect(userExists).toBe(false);
+    });
+    (0, jasmine_utils_1.itCond)(`won't startup with a wrong pass`, async () => {
+        // start MailerId provisioning
+        const userExists = await w3n.signIn.startLoginToRemoteStorage(user.userId);
+        expect(userExists).toBe(true);
+        // completing MailerId provisioning
+        const notifications = [];
+        const notifier = (p) => { notifications.push(p); };
+        const ok = await w3n.signIn.completeLoginAndLocalSetup('wrong password', notifier);
+        expect(ok).withContext('false should be returned for wrong pass').toBe(false);
+        (0, startup_1.checkKeyDerivNotifications)(notifications);
+    }, 60000);
+    (0, jasmine_utils_1.itCond)('starts with correct pass', async () => {
+        const core = s.runners.get(user.userId).core;
+        try {
+            core.makeCAPsForApp(core_runner_1.testApp.appDomain, core_runner_1.testApp.capsRequested);
+            fail(`Attempt to make app CAPs before core initialization should throw up`);
+        }
+        catch (err) { }
+        // start login
+        const userExists = await w3n.signIn.startLoginToRemoteStorage(user.userId);
+        expect(userExists).toBe(true);
+        // complete login and a local storage setup
+        const notifications = [];
+        const notifier = (p) => { notifications.push(p); };
+        const ok = await w3n.signIn.completeLoginAndLocalSetup(user.pass, notifier);
+        expect(ok).withContext('indicates completion of login and storage setup').toBe(true);
+        (0, startup_1.checkKeyDerivNotifications)(notifications);
+        const initAs = await coreInit;
+        expect(initAs).toBe(user.userId);
+        await coreAppsInit;
+        try {
+            const { caps, close } = core.makeCAPsForApp(core_runner_1.testApp.appDomain, core_runner_1.testApp.capsRequested);
+            expect(typeof caps).toBe('object');
+            expect(typeof close).toBe('function');
+            close();
+        }
+        catch (err) {
+            fail(err);
+        }
+    }, 60000);
+});

package/build/tests/caps-api/startup/signin-with-cache.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/caps-api/startup/signin-with-cache.js

@@ -0,0 +1,83 @@
+"use strict";
+/*
+ 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
+ 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 });
+const jasmine_utils_1 = require("../../libs-for-tests/jasmine-utils");
+const setups_1 = require("../../libs-for-tests/setups");
+const startup_1 = require("../../libs-for-tests/startup");
+const core_runner_1 = require("../../libs-for-tests/core-runner");
+const sleep_1 = require("../../../lib-common/processes/sleep");
+// NOTE: it-specs inside signIn process expect to run in a given order -- they
+//		change app's state, expected by following specs in this describe.
+describe('signIn process (with cache)', () => {
+    const s = (0, setups_1.setupWithUsers)();
+    let user;
+    let w3n;
+    let coreInit;
+    let coreAppsInit;
+    let closeIPC;
+    (0, jasmine_utils_1.beforeAllWithTimeoutLog)(async () => {
+        if (!s.isUp) {
+            return;
+        }
+        user = s.users[0];
+        const runner = s.runners.get(user.userId);
+        await (0, sleep_1.sleep)(3000);
+        await runner.restart(false, false);
+        ({ closeIPC, coreInit, coreAppsInit, w3n } = runner.startCore());
+    }, 30000);
+    (0, jasmine_utils_1.afterAllCond)(async () => {
+        closeIPC();
+    });
+    (0, jasmine_utils_1.itCond)('identifies user on disk', async () => {
+        const users = await w3n.signIn.getUsersOnDisk();
+        expect(Array.isArray(users)).toBe(true);
+        expect(users).toContain(user.userId);
+    });
+    (0, jasmine_utils_1.itCond)(`won't startup with a wrong pass`, async () => {
+        const notifications = [];
+        const notifier = (p) => { notifications.push(p); };
+        const passOK = await w3n.signIn.useExistingStorage(user.userId, 'wrong password', notifier);
+        expect(passOK).toBe(false);
+        (0, startup_1.checkKeyDerivNotifications)(notifications);
+    }, 60000);
+    (0, jasmine_utils_1.itCond)('starts with correct pass', async () => {
+        const core = s.runners.get(user.userId).core;
+        try {
+            core.makeCAPsForApp(core_runner_1.testApp.appDomain, core_runner_1.testApp.capsRequested);
+            fail(`Attempt to make app CAPs before core initialization should throw up`);
+        }
+        catch (err) { }
+        const notifications = [];
+        const notifier = (p) => { notifications.push(p); };
+        const passOK = await w3n.signIn.useExistingStorage(user.userId, user.pass, notifier);
+        expect(passOK).toBe(true);
+        (0, startup_1.checkKeyDerivNotifications)(notifications);
+        const initAs = await coreInit;
+        expect(initAs).toBe(user.userId);
+        await coreAppsInit;
+        try {
+            const { caps, close } = core.makeCAPsForApp(core_runner_1.testApp.appDomain, core_runner_1.testApp.capsRequested);
+            expect(typeof caps).toBe('object');
+            expect(typeof close).toBe('function');
+            close();
+        }
+        catch (err) {
+            fail(err);
+        }
+    }, 60000);
+});

package/build/tests/caps-api/startup/signup-with-token.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/caps-api/startup/signup-with-token.js

@@ -0,0 +1,53 @@
+"use strict";
+/*
+ Copyright (C) 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
+ 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 });
+const jasmine_utils_1 = require("../../libs-for-tests/jasmine-utils");
+const setups_1 = require("../../libs-for-tests/setups");
+describe('signUp process with token for single user', () => {
+    const s = (0, setups_1.minimalSetup)({
+        noTokenSignup: [],
+        other: ['home.town']
+    });
+    let w3n;
+    let coreInit;
+    let coreAppsInit;
+    let closeIPC;
+    const userId = 'Bob Miller @home.town';
+    const pass = 'some long passphrase';
+    let token;
+    (0, jasmine_utils_1.beforeAllWithTimeoutLog)(async () => {
+        if (!s.isUp) {
+            return;
+        }
+        ({ closeIPC, coreInit, coreAppsInit, w3n } = s.runner.startCore());
+        token = await s.server.createSingleUserSignupCtx(userId);
+    });
+    (0, jasmine_utils_1.afterAllCond)(async () => {
+        closeIPC();
+    });
+    (0, jasmine_utils_1.itCond)('creates user account, allowing caps for apps', async () => {
+        await w3n.signUp.createUserParams(pass, () => { });
+        let isCreated = await w3n.signUp.addUser(userId, 'wrong token');
+        expect(isCreated).toBe(false);
+        isCreated = await w3n.signUp.addUser(userId, token);
+        expect(isCreated).toBe(true);
+        const initAs = await coreInit;
+        expect(initAs).toBe(userId);
+        await coreAppsInit;
+    }, 10000);
+});

package/build/tests/caps-api/startup/signup.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/caps-api/startup/signup.js

@@ -0,0 +1,86 @@
+"use strict";
+/*
+ Copyright (C) 2016, 2018, 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
+ 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 });
+const jasmine_utils_1 = require("../../libs-for-tests/jasmine-utils");
+const setups_1 = require("../../libs-for-tests/setups");
+const startup_1 = require("../../libs-for-tests/startup");
+const core_runner_1 = require("../../libs-for-tests/core-runner");
+// NOTE: it-specs inside signUp process expect to run in a given order -- they
+//		change app's state, expected by following specs in this describe.
+describe('signUp process', () => {
+    const s = (0, setups_1.minimalSetup)();
+    let w3n;
+    let coreInit;
+    let coreAppsInit;
+    let closeIPC;
+    (0, jasmine_utils_1.beforeAllWithTimeoutLog)(async () => {
+        if (!s.isUp) {
+            return;
+        }
+        ({ closeIPC, coreInit, coreAppsInit, w3n } = s.runner.startCore());
+    }, 30000);
+    (0, jasmine_utils_1.afterAllCond)(async () => {
+        closeIPC();
+    });
+    const name = 'Mike Marlow ';
+    const pass = 'some long passphrase';
+    (0, jasmine_utils_1.itCond)('gets available domains', async () => {
+        const domains = await w3n.signUp.getAvailableDomains();
+        expect(Array.isArray(domains)).toBe(true);
+        expect(domains.length).toBe(s.signupDomains.length);
+        for (let d of s.signupDomains) {
+            expect(domains).toContain(d);
+        }
+    });
+    (0, jasmine_utils_1.itCond)('gets available addresses', async () => {
+        const addresses = await w3n.signUp.getAvailableAddresses(name);
+        expect(Array.isArray(addresses)).toBe(true);
+        expect(addresses.length).toBe(s.signupDomains.length);
+        for (let d of s.signupDomains) {
+            expect(addresses).toContain(`${name}@${d}`);
+        }
+    });
+    (0, jasmine_utils_1.itCond)('creates user parameters', async () => {
+        const notifications = [];
+        const notifier = (p) => { notifications.push(p); };
+        await w3n.signUp.createUserParams(pass, notifier);
+        (0, startup_1.checkKeyDerivNotifications)(notifications);
+    }, 60000);
+    (0, jasmine_utils_1.itCond)('creates user account, allowing caps for apps', async () => {
+        try {
+            s.runner.core.makeCAPsForApp(core_runner_1.testApp.appDomain, core_runner_1.testApp.capsRequested);
+            fail(`Attempt to make app CAPs before core initialization should throw up`);
+        }
+        catch (err) { }
+        const userId = `${name}@${s.signupDomains[0]}`;
+        const isCreated = await w3n.signUp.addUser(userId);
+        expect(isCreated).toBe(true);
+        const initAs = await coreInit;
+        expect(initAs).toBe(userId);
+        await coreAppsInit;
+        try {
+            const { caps, close } = s.runner.core.makeCAPsForApp(core_runner_1.testApp.appDomain, core_runner_1.testApp.capsRequested);
+            expect(typeof caps).toBe('object');
+            expect(typeof close).toBe('function');
+            close();
+        }
+        catch (err) {
+            fail(err);
+        }
+    }, 10000);
+});

package/build/tests/caps-api/storage.d.ts

@@ -0,0 +1 @@
+export {};