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

package/src/User.ts

@@ -1,4 +1,5 @@
-import {
+import type {
+  Nymph,
   EntityData,
   EntityJson,
   EntityPatch,
@@ -6,7 +7,7 @@ import {
   SerializedEntityData,
 } from '@nymphjs/nymph';
 import { humanSecret, nanoid } from '@nymphjs/guid';
-import { EmailOptions } from 'email-templates';
+import type { EmailOptions } from 'email-templates';
 import strtotime from 'locutus/php/datetime/strtotime';
 import Base64 from 'crypto-js/enc-base64';
 import sha256 from 'crypto-js/sha256';
@@ -17,7 +18,8 @@ import { toDataURL } from 'qrcode';
 
 import { enforceTilmeld } from './enforceTilmeld';
 import AbleObject from './AbleObject';
-import Group, { GroupData } from './Group';
+import type Group from './Group';
+import type { GroupData } from './Group';
 import {
   BadDataError,
   BadEmailError,
@@ -273,9 +275,13 @@ export default class User extends AbleObject<UserData> {
    */
   private $gatekeeperCache?: { [k: string]: true };
   /**
-   * This is explicitly used only during the registration proccess.
+   * This should only be used by the backend.
    */
   private $skipAcWhenSaving = false;
+  /**
+   * This should only be used by the backend.
+   */
+  private $skipAcWhenDeleting = false;
   /**
    * The user's group descendants.
    */
@@ -308,17 +314,6 @@ export default class User extends AbleObject<UserData> {
     return entity;
   }
 
-  constructor() {
-    super();
-
-    // Defaults.
-    this.$data.enabled = true;
-    this.$data.abilities = [];
-    this.$data.groups = [];
-    this.$data.inheritAbilities = true;
-    this.$updateDataProtection();
-  }
-
   public static current(returnObjectIfNotExist: true): User & UserData;
   public static current(
     returnObjectIfNotExist?: false,
@@ -531,6 +526,47 @@ export default class User extends AbleObject<UserData> {
     return result;
   }
 
+  constructor() {
+    super();
+
+    // Defaults.
+    this.$data.enabled = true;
+    this.$data.abilities = [];
+    this.$data.groups = [];
+    this.$data.inheritAbilities = true;
+    this.$updateDataProtection();
+  }
+
+  $setNymph(nymph: 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(): Promise<string[]> {
+    const tilmeld = 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;
+  }
+
   public async $login(data: {
     username: string;
     password: string;
@@ -1793,7 +1829,7 @@ export default class User extends AbleObject<UserData> {
     const transaction = 'tilmeld-register-' + nanoid();
     const nymph = this.$nymph;
     const tnymph = await this.$nymph.startTransaction(transaction);
-    this.$nymph = tnymph;
+    this.$setNymph(tnymph);
     tilmeld = enforceTilmeld(this);
 
     let message = '';
@@ -1809,7 +1845,7 @@ export default class User extends AbleObject<UserData> {
         }
       } catch (e: any) {
         await tnymph.rollback(transaction);
-        this.$nymph = nymph;
+        this.$setNymph(nymph);
         return {
           result: false,
           loggedin: false,
@@ -1817,78 +1853,6 @@ export default class User extends AbleObject<UserData> {
         };
       }
 
-      // Add primary group.
-      let generatedPrimaryGroup: (Group & GroupData) | null = 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
@@ -1901,7 +1865,7 @@ export default class User extends AbleObject<UserData> {
         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) {
@@ -1950,21 +1914,6 @@ export default class User extends AbleObject<UserData> {
           );
         }
 
-        // 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 &&
@@ -2012,7 +1961,7 @@ export default class User extends AbleObject<UserData> {
           `Error registering new user "${this.$data.username}".`,
         );
         await tnymph.rollback(transaction);
-        this.$nymph = nymph;
+        this.$setNymph(nymph);
         return {
           result: false,
           loggedin: false,
@@ -2025,13 +1974,13 @@ export default class User extends AbleObject<UserData> {
         `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: any) {
       throw e;
@@ -2051,6 +2000,7 @@ export default class User extends AbleObject<UserData> {
     }
 
     if (
+      !this.$skipAcWhenSaving &&
       tilmeld.gatekeeper('tilmeld/admin') &&
       !tilmeld.gatekeeper('system/admin') &&
       this.$data.abilities?.includes('system/admin')
@@ -2277,42 +2227,129 @@ export default class User extends AbleObject<UserData> {
       throw new BadDataError('A password is required.');
     }
 
-    try {
-      tilmeld.config.validatorUser(tilmeld, this);
-    } catch (e: any) {
-      throw new BadDataError(e?.message);
-    }
-
     // Start transaction.
     const transaction = 'tilmeld-save-' + nanoid();
     const nymph = this.$nymph;
     const tnymph = await this.$nymph.startTransaction(transaction);
-    this.$nymph = tnymph;
+    this.$setNymph(tnymph);
     tilmeld = 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: any) {
-        await tnymph.rollback(transaction);
-        this.$nymph = nymph;
-        throw e;
+        throw new BadDataError(e?.message);
       }
+    } catch (e: any) {
+      await tnymph.rollback(transaction);
+      this.$setNymph(nymph);
+      throw e;
     }
 
     let ret: boolean;
@@ -2322,11 +2359,26 @@ export default class User extends AbleObject<UserData> {
 
     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: any) {
       await tnymph.rollback(transaction);
-      this.$nymph = nymph;
+      this.$setNymph(nymph);
       throw e;
     }
+
     if (ret) {
       if (sendVerification) {
         // The email has changed, so send a new verification email.
@@ -2335,7 +2387,7 @@ export default class User extends AbleObject<UserData> {
           this.guid = preGuid;
           this.cdate = preCdate;
           this.mdate = preMdate;
-          this.$nymph = nymph;
+          this.$setNymph(nymph);
           throw new Error("Couldn't send verification email.");
         }
       }
@@ -2353,7 +2405,7 @@ export default class User extends AbleObject<UserData> {
     } else {
       await tnymph.rollback(transaction);
     }
-    this.$nymph = nymph;
+    this.$setNymph(nymph);
     return ret;
   }
 
@@ -2375,10 +2427,11 @@ export default class User extends AbleObject<UserData> {
 
   public async $delete() {
     const tilmeld = enforceTilmeld(this);
-    if (!tilmeld.gatekeeper('tilmeld/admin')) {
+    if (!this.$skipAcWhenDeleting && !tilmeld.gatekeeper('tilmeld/admin')) {
       throw new BadDataError("You don't have the authority to delete users.");
     }
     if (
+      !this.$skipAcWhenDeleting &&
       !tilmeld.gatekeeper('system/admin') &&
       this.$data.abilities?.includes('system/admin')
     ) {
@@ -2392,6 +2445,22 @@ export default class User extends AbleObject<UserData> {
     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;
+  }
+
   public static on<T extends EventType>(
     event: T,
     callback: T extends 'checkUsername'

package/tsconfig.json

@@ -2,8 +2,8 @@
   "extends": "@tsconfig/recommended/tsconfig.json",
 
   "compilerOptions": {
-    "lib": ["ES2021"],
-    "target": "ES2021",
+    "lib": ["ES2023"],
+    "target": "ES2022",
     "noImplicitAny": true,
     "removeComments": false,
     "sourceMap": true,