@nymphjs/tilmeld 1.0.0-beta.61 → 1.0.0-beta.63

package/dist/User.js

@@ -24,6 +24,94 @@ const errors_1 = require("./errors");
  * @see http://nymph.io/
  */
 class User extends AbleObject_1.default {
+    /**
+     * The instance of Tilmeld to use for queries.
+     */
+    static ETYPE = 'tilmeld_user';
+    static class = 'User';
+    static checkUsernameCallbacks = [];
+    static beforeRegisterCallbacks = [];
+    static afterRegisterCallbacks = [];
+    static beforeLoginCallbacks = [];
+    static afterLoginCallbacks = [];
+    static beforeLogoutCallbacks = [];
+    static afterLogoutCallbacks = [];
+    static DEFAULT_CLIENT_ENABLED_METHODS = [
+        '$checkUsername',
+        '$checkEmail',
+        '$checkPhone',
+        '$getAvatar',
+        '$register',
+    ];
+    static DEFAULT_PRIVATE_DATA = [
+        // The things that are commented are there to show what is _not_ private.
+        'abilities',
+        // 'username',
+        // 'nameFirst',
+        // 'nameMiddle',
+        // 'nameLast',
+        // 'name',
+        'email',
+        // 'avatar',
+        'phone',
+        'group',
+        'groups',
+        'inheritAbilities',
+        'enabled',
+        'secret',
+        'emailChangeDate',
+        'newEmailSecret',
+        'newEmailAddress',
+        'cancelEmailSecret',
+        'cancelEmailAddress',
+        'recoverSecret',
+        'recoverSecretDate',
+        'salt',
+        'password',
+        'passwordTemp',
+        'revokeTokenDate',
+        'totpSecret',
+    ];
+    static DEFAULT_ALLOWLIST_DATA = [];
+    $clientEnabledMethods = [...User.DEFAULT_CLIENT_ENABLED_METHODS];
+    static clientEnabledStaticMethods = [
+        'current',
+        'loginUser',
+        'sendRecovery',
+        'recover',
+        'getClientConfig',
+    ];
+    $privateData = [...User.DEFAULT_PRIVATE_DATA];
+    static searchRestrictedData = [...User.DEFAULT_PRIVATE_DATA];
+    $allowlistData = [...User.DEFAULT_ALLOWLIST_DATA];
+    $allowlistTags = [];
+    /**
+     * Gatekeeper ability cache.
+     *
+     * Gatekeeper will cache the user's abilities that it calculates, so it can
+     * check faster if that user has been checked before.
+     */
+    $gatekeeperCache;
+    /**
+     * This should only be used by the backend.
+     */
+    $skipAcWhenSaving = false;
+    /**
+     * This should only be used by the backend.
+     */
+    $skipAcWhenDeleting = false;
+    /**
+     * The user's group descendants.
+     */
+    $descendantGroups;
+    /**
+     * Used to save the current email address to send verification if it changes
+     * from the frontend.
+     *
+     * If you are changing a user's email address and want to bypass email
+     * verification, don't set this.
+     */
+    $originalEmail;
     static async factoryUsername(username) {
         const entity = new this();
         if (username != null) {
@@ -39,23 +127,6 @@ class User extends AbleObject_1.default {
         }
         return entity;
     }
-    constructor() {
-        super();
-        this.$clientEnabledMethods = [...User.DEFAULT_CLIENT_ENABLED_METHODS];
-        this.$privateData = [...User.DEFAULT_PRIVATE_DATA];
-        this.$allowlistData = [...User.DEFAULT_ALLOWLIST_DATA];
-        this.$allowlistTags = [];
-        /**
-         * This is explicitly used only during the registration proccess.
-         */
-        this.$skipAcWhenSaving = false;
-        // Defaults.
-        this.$data.enabled = true;
-        this.$data.abilities = [];
-        this.$data.groups = [];
-        this.$data.inheritAbilities = true;
-        this.$updateDataProtection();
-    }
     static current(returnObjectIfNotExist) {
         const tilmeld = (0, enforceTilmeld_1.enforceTilmeld)(this);
         if (tilmeld.currentUser == null) {
@@ -216,6 +287,40 @@ class User extends AbleObject_1.default {
         }
         return result;
     }
+    constructor() {
+        super();
+        // Defaults.
+        this.$data.enabled = true;
+        this.$data.abilities = [];
+        this.$data.groups = [];
+        this.$data.inheritAbilities = true;
+        this.$updateDataProtection();
+    }
+    $setNymph(nymph) {
+        this.$nymph = nymph;
+        if (!this.$asleep()) {
+            if (this.$data.group && this.$data.group.$nymph !== nymph) {
+                this.$data.group.$setNymph(nymph);
+            }
+            for (const group of this.$data.groups ?? []) {
+                if (group && group.$nymph !== nymph) {
+                    group.$setNymph(nymph);
+                }
+            }
+        }
+    }
+    async $getUniques() {
+        const tilmeld = (0, enforceTilmeld_1.enforceTilmeld)(this);
+        const uniques = [`u:${this.$data.username}`];
+        if (!tilmeld.config.emailUsernames &&
+            tilmeld.config.userFields.includes('email')) {
+            uniques.push(`e:${this.$data.email}`);
+            if (this.$data.newEmailAddress != null) {
+                uniques.push(`e:${this.$data.newEmailAddress}`);
+            }
+        }
+        return uniques;
+    }
     async $login(data) {
         const tilmeld = (0, enforceTilmeld_1.enforceTilmeld)(this);
         if (this.guid == null) {
@@ -1227,7 +1332,7 @@ class User extends AbleObject_1.default {
         const transaction = 'tilmeld-register-' + (0, guid_1.nanoid)();
         const nymph = this.$nymph;
         const tnymph = await this.$nymph.startTransaction(transaction);
-        this.$nymph = tnymph;
+        this.$setNymph(tnymph);
         tilmeld = (0, enforceTilmeld_1.enforceTilmeld)(this);
         let message = '';
         let loggedin = false;
@@ -1242,71 +1347,13 @@ class User extends AbleObject_1.default {
             }
             catch (e) {
                 await tnymph.rollback(transaction);
-                this.$nymph = nymph;
+                this.$setNymph(nymph);
                 return {
                     result: false,
                     loggedin: false,
                     message: e.message,
                 };
             }
-            // Add primary group.
-            let generatedPrimaryGroup = null;
-            if (tilmeld.config.generatePrimary) {
-                // Generate a new primary group for the user.
-                generatedPrimaryGroup = await tilmeld.Group.factory();
-                generatedPrimaryGroup.groupname = this.$data.username;
-                generatedPrimaryGroup.avatar = this.$data.avatar;
-                if (tilmeld.config.userFields.includes('name')) {
-                    generatedPrimaryGroup.name = this.$data.name;
-                }
-                if (tilmeld.config.userFields.includes('email')) {
-                    generatedPrimaryGroup.email = this.$data.email;
-                }
-                const parent = await tnymph.getEntity({ class: tilmeld.Group }, {
-                    type: '&',
-                    equal: ['defaultPrimary', true],
-                });
-                if (parent != null) {
-                    generatedPrimaryGroup.parent = parent;
-                }
-                if (!(await generatedPrimaryGroup.$saveSkipAC())) {
-                    await tnymph.rollback(transaction);
-                    this.$nymph = nymph;
-                    return {
-                        result: false,
-                        loggedin: false,
-                        message: 'Error creating primary group for user.',
-                    };
-                }
-                this.$data.group = generatedPrimaryGroup;
-            }
-            else {
-                // Add the default primary.
-                const group = await tnymph.getEntity({ class: tilmeld.Group }, {
-                    type: '&',
-                    equal: ['defaultPrimary', true],
-                });
-                if (group != null) {
-                    this.$data.group = group;
-                }
-            }
-            // Add secondary groups.
-            if (tilmeld.config.userFields.includes('email') &&
-                tilmeld.config.verifyEmail &&
-                tilmeld.config.unverifiedAccess) {
-                // Add the default secondaries for unverified users.
-                this.$data.groups = await tnymph.getEntities({ class: tilmeld.Group }, {
-                    type: '&',
-                    equal: ['unverifiedSecondary', true],
-                });
-            }
-            else {
-                // Add the default secondaries.
-                this.$data.groups = await tnymph.getEntities({ class: tilmeld.Group }, {
-                    type: '&',
-                    equal: ['defaultSecondary', true],
-                });
-            }
             if (tilmeld.config.userFields.includes('email') &&
                 tilmeld.config.verifyEmail) {
                 // The user will be enabled after verifying their e-mail address.
@@ -1317,7 +1364,7 @@ class User extends AbleObject_1.default {
             else {
                 this.$data.enabled = true;
             }
-            // If create_admin is true and there are no other users, grant
+            // If createAdmin is true and there are no other users, grant
             // "system/admin".
             let madeAdmin = false;
             if (tilmeld.config.createAdmin) {
@@ -1354,19 +1401,6 @@ class User extends AbleObject_1.default {
                         },
                     }, this);
                 }
-                // Save the primary group.
-                if (generatedPrimaryGroup != null) {
-                    generatedPrimaryGroup.user = this;
-                    if (!(await generatedPrimaryGroup.$saveSkipAC())) {
-                        await tnymph.rollback(transaction);
-                        this.$nymph = nymph;
-                        return {
-                            result: false,
-                            loggedin: false,
-                            message: 'Your primary group could not be assigned. Please try again later.',
-                        };
-                    }
-                }
                 // Finish up.
                 if (tilmeld.config.verifyEmail &&
                     !tilmeld.config.unverifiedAccess &&
@@ -1409,7 +1443,7 @@ class User extends AbleObject_1.default {
             else {
                 this.$nymph.config.debugError('tilmeld', `Error registering new user "${this.$data.username}".`);
                 await tnymph.rollback(transaction);
-                this.$nymph = nymph;
+                this.$setNymph(nymph);
                 return {
                     result: false,
                     loggedin: false,
@@ -1420,12 +1454,12 @@ class User extends AbleObject_1.default {
         catch (e) {
             this.$nymph.config.debugError('tilmeld', `Error registering new user "${this.$data.username}": ${e}`);
             await tnymph.rollback(transaction);
-            this.$nymph = nymph;
+            this.$setNymph(nymph);
             throw e;
         }
         try {
             await tnymph.commit(transaction);
-            this.$nymph = nymph;
+            this.$setNymph(nymph);
             await this.$nymph.tilmeld?.fillSession(this);
         }
         catch (e) {
@@ -1442,7 +1476,8 @@ class User extends AbleObject_1.default {
         if (this.$data.username == null || !this.$data.username.trim().length) {
             return false;
         }
-        if (tilmeld.gatekeeper('tilmeld/admin') &&
+        if (!this.$skipAcWhenSaving &&
+            tilmeld.gatekeeper('tilmeld/admin') &&
             !tilmeld.gatekeeper('system/admin') &&
             this.$data.abilities?.includes('system/admin')) {
             throw new errors_1.BadDataError("You don't have the authority to modify system admins.");
@@ -1615,53 +1650,133 @@ class User extends AbleObject_1.default {
         if (this.$data.password == null) {
             throw new errors_1.BadDataError('A password is required.');
         }
-        try {
-            tilmeld.config.validatorUser(tilmeld, this);
-        }
-        catch (e) {
-            throw new errors_1.BadDataError(e?.message);
-        }
         // Start transaction.
         const transaction = 'tilmeld-save-' + (0, guid_1.nanoid)();
         const nymph = this.$nymph;
         const tnymph = await this.$nymph.startTransaction(transaction);
-        this.$nymph = tnymph;
+        this.$setNymph(tnymph);
         tilmeld = (0, enforceTilmeld_1.enforceTilmeld)(this);
-        const group = this.$data.group;
-        await group?.$wake();
-        if (group != null && group.user != null && this.$is(group.user)) {
-            try {
+        // If the primary group is generated now, the user assigned to it won't have
+        // a guid yet, so it needs to be assigned after the user is saved.
+        let saveGeneratedPrimaryGroupAgain = false;
+        try {
+            let group = this.$data.group;
+            await group?.$wake();
+            if (group == null && this.guid == null) {
+                if (tilmeld.config.generatePrimary) {
+                    // Generate a new primary group for the user.
+                    group = await tilmeld.Group.factory();
+                    // This user doesn't have a guid yet, so that's why we set
+                    // saveGeneratedPrimaryGroupAgain.
+                    group.user = this;
+                    saveGeneratedPrimaryGroupAgain = true;
+                    const parent = await tnymph.getEntity({ class: tilmeld.Group }, {
+                        type: '&',
+                        equal: ['defaultPrimary', true],
+                    });
+                    if (parent != null) {
+                        group.parent = parent;
+                    }
+                }
+                else {
+                    // Add the default primary.
+                    const group = await tnymph.getEntity({ class: tilmeld.Group }, {
+                        type: '&',
+                        equal: ['defaultPrimary', true],
+                    });
+                    if (group != null) {
+                        this.$data.group = group;
+                    }
+                }
+            }
+            if (group != null && group.user != null && this.$is(group.user)) {
                 // Update the user's generated primary group.
-                group.groupname = this.$data.username;
-                group.avatar = this.$data.avatar;
-                if (tilmeld.config.userFields.includes('email')) {
+                let changed = false;
+                if (group.groupname !== this.$data.username) {
+                    group.groupname = this.$data.username;
+                    changed = true;
+                }
+                if (group.avatar !== this.$data.avatar) {
+                    group.avatar = this.$data.avatar;
+                    changed = true;
+                }
+                if (tilmeld.config.userFields.includes('email') &&
+                    group.email !== this.$data.email) {
                     group.email = this.$data.email;
+                    changed = true;
                 }
-                if (tilmeld.config.userFields.includes('name')) {
+                if (tilmeld.config.userFields.includes('name') &&
+                    group.name !== this.$data.name) {
                     group.name = this.$data.name;
+                    changed = true;
                 }
-                if (tilmeld.config.userFields.includes('phone')) {
+                if (tilmeld.config.userFields.includes('phone') &&
+                    group.phone !== this.$data.phone) {
                     group.phone = this.$data.phone;
+                    changed = true;
+                }
+                if (changed) {
+                    if (!(await group.$saveSkipAC())) {
+                        throw Error('Error updating primary group for user.');
+                    }
                 }
-                await group.$saveSkipAC();
                 this.$data.group = group;
             }
+            if (this.$data.groups == null || this.$data.groups.length === 0) {
+                // Add secondary groups.
+                if (tilmeld.config.userFields.includes('email') &&
+                    tilmeld.config.verifyEmail &&
+                    tilmeld.config.unverifiedAccess &&
+                    this.$data.secret != null) {
+                    // Add the default secondaries for unverified users.
+                    this.$data.groups = await tnymph.getEntities({ class: tilmeld.Group }, {
+                        type: '&',
+                        equal: ['unverifiedSecondary', true],
+                    });
+                }
+                else {
+                    // Add the default secondaries.
+                    this.$data.groups = await tnymph.getEntities({ class: tilmeld.Group }, {
+                        type: '&',
+                        equal: ['defaultSecondary', true],
+                    });
+                }
+            }
+            try {
+                tilmeld.config.validatorUser(tilmeld, this);
+            }
             catch (e) {
-                await tnymph.rollback(transaction);
-                this.$nymph = nymph;
-                throw e;
+                throw new errors_1.BadDataError(e?.message);
             }
         }
+        catch (e) {
+            await tnymph.rollback(transaction);
+            this.$setNymph(nymph);
+            throw e;
+        }
         let ret;
         let preGuid = this.guid;
         let preCdate = this.cdate;
         let preMdate = this.mdate;
         try {
             ret = await super.$save();
+            if (ret && saveGeneratedPrimaryGroupAgain) {
+                const group = this.$data.group;
+                if (group == null) {
+                    throw Error('Generated primary group not found.');
+                }
+                await group.$wake();
+                // Now this user has a GUID, so saving it on the group will succeed.
+                group.user = this;
+                if (!(await group.$saveSkipAC())) {
+                    throw Error("Generated primary group couldn't be saved.");
+                }
+                this.$data.group = group;
+            }
         }
         catch (e) {
             await tnymph.rollback(transaction);
-            this.$nymph = nymph;
+            this.$setNymph(nymph);
             throw e;
         }
         if (ret) {
@@ -1672,7 +1787,7 @@ class User extends AbleObject_1.default {
                     this.guid = preGuid;
                     this.cdate = preCdate;
                     this.mdate = preMdate;
-                    this.$nymph = nymph;
+                    this.$setNymph(nymph);
                     throw new Error("Couldn't send verification email.");
                 }
             }
@@ -1688,7 +1803,7 @@ class User extends AbleObject_1.default {
         else {
             await tnymph.rollback(transaction);
         }
-        this.$nymph = nymph;
+        this.$setNymph(nymph);
         return ret;
     }
     /**
@@ -1707,10 +1822,11 @@ class User extends AbleObject_1.default {
     }
     async $delete() {
         const tilmeld = (0, enforceTilmeld_1.enforceTilmeld)(this);
-        if (!tilmeld.gatekeeper('tilmeld/admin')) {
+        if (!this.$skipAcWhenDeleting && !tilmeld.gatekeeper('tilmeld/admin')) {
             throw new errors_1.BadDataError("You don't have the authority to delete users.");
         }
-        if (!tilmeld.gatekeeper('system/admin') &&
+        if (!this.$skipAcWhenDeleting &&
+            !tilmeld.gatekeeper('system/admin') &&
             this.$data.abilities?.includes('system/admin')) {
             throw new errors_1.BadDataError("You don't have the authority to delete system admins.");
         }
@@ -1719,6 +1835,20 @@ class User extends AbleObject_1.default {
         }
         return await super.$delete();
     }
+    /*
+     * This should *never* be accessible on the client.
+     */
+    async $deleteSkipAC() {
+        this.$skipAcWhenDeleting = true;
+        return await this.$delete();
+    }
+    $tilmeldDeleteSkipAC() {
+        if (this.$skipAcWhenDeleting) {
+            this.$skipAcWhenDeleting = false;
+            return true;
+        }
+        return false;
+    }
     static on(event, callback) {
         const prop = (event + 'Callbacks');
         if (!(prop in this)) {
@@ -1742,62 +1872,5 @@ class User extends AbleObject_1.default {
         return true;
     }
 }
-/**
- * The instance of Tilmeld to use for queries.
- */
-User.ETYPE = 'tilmeld_user';
-User.class = 'User';
-User.checkUsernameCallbacks = [];
-User.beforeRegisterCallbacks = [];
-User.afterRegisterCallbacks = [];
-User.beforeLoginCallbacks = [];
-User.afterLoginCallbacks = [];
-User.beforeLogoutCallbacks = [];
-User.afterLogoutCallbacks = [];
-User.DEFAULT_CLIENT_ENABLED_METHODS = [
-    '$checkUsername',
-    '$checkEmail',
-    '$checkPhone',
-    '$getAvatar',
-    '$register',
-];
-User.DEFAULT_PRIVATE_DATA = [
-    // The things that are commented are there to show what is _not_ private.
-    'abilities',
-    // 'username',
-    // 'nameFirst',
-    // 'nameMiddle',
-    // 'nameLast',
-    // 'name',
-    'email',
-    // 'avatar',
-    'phone',
-    'group',
-    'groups',
-    'inheritAbilities',
-    'enabled',
-    'secret',
-    'emailChangeDate',
-    'newEmailSecret',
-    'newEmailAddress',
-    'cancelEmailSecret',
-    'cancelEmailAddress',
-    'recoverSecret',
-    'recoverSecretDate',
-    'salt',
-    'password',
-    'passwordTemp',
-    'revokeTokenDate',
-    'totpSecret',
-];
-User.DEFAULT_ALLOWLIST_DATA = [];
-User.clientEnabledStaticMethods = [
-    'current',
-    'loginUser',
-    'sendRecovery',
-    'recover',
-    'getClientConfig',
-];
-User.searchRestrictedData = [...User.DEFAULT_PRIVATE_DATA];
 exports.default = User;
 //# sourceMappingURL=User.js.map