@nymphjs/tilmeld 1.0.0-beta.121 → 1.0.0-beta.123

package/src/Group.ts

@@ -1,12 +1,13 @@
 import crypto from 'node:crypto';
-import type {
-  Nymph,
-  EntityData,
-  EntityJson,
-  EntityPatch,
-  Options,
-  Selector,
-  SerializedEntityData,
+import {
+  type EntityData,
+  type EntityJson,
+  type EntityPatch,
+  type Options,
+  type Selector,
+  type SerializedEntityData,
+  transaction,
+  transactional,
 } from '@nymphjs/nymph';
 import { nanoid } from '@nymphjs/guid';
 import { difference, xor } from 'lodash-es';
@@ -310,18 +311,6 @@ export default class Group extends AbleObject<GroupData> {
     this.$updateDataProtection();
   }
 
-  $setNymph(nymph: Nymph) {
-    this.$nymph = nymph;
-    if (!this.$asleep()) {
-      if (this.$data.user && this.$data.user.$nymph !== nymph) {
-        this.$data.user.$setNymph(nymph);
-      }
-      if (this.$data.parent && this.$data.parent.$nymph !== nymph) {
-        this.$data.parent.$setNymph(nymph);
-      }
-    }
-  }
-
   async $getUniques(): Promise<string[]> {
     const tilmeld = enforceTilmeld(this);
     const uniques = [`u:${this.$data.groupname}`];
@@ -337,7 +326,7 @@ export default class Group extends AbleObject<GroupData> {
     return uniques;
   }
 
-  public $getAvatar() {
+  public $getAvatar(): string {
     if (this.$data.avatar != null && this.$data.avatar !== '') {
       return this.$data.avatar;
     }
@@ -504,7 +493,7 @@ export default class Group extends AbleObject<GroupData> {
   }
 
   /**
-   * Check whether the group is a descendant of a group.
+   * Check whether the group is a descendant of the given group.
    *
    * @param group The group, or the group's GUID.
    * @returns True or false.
@@ -542,7 +531,7 @@ export default class Group extends AbleObject<GroupData> {
    *
    * @returns An array of groups.
    */
-  public async $getChildren() {
+  public async $getChildren(): Promise<(Group & GroupData)[]> {
     const tilmeld = enforceTilmeld(this);
     return await this.$nymph.getEntities(
       { class: tilmeld.Group },
@@ -558,10 +547,12 @@ export default class Group extends AbleObject<GroupData> {
    * Gets an array of the group's descendant groups.
    *
    * @param andSelf Include this group in the returned array.
+   * @param andDisabled Include disabled groups.
    * @returns An array of groups.
    */
   public async $getDescendants(
     andSelf = false,
+    andDisabled = false,
   ): Promise<(Group & GroupData)[]> {
     const tilmeld = enforceTilmeld(this);
     let groups: (Group & GroupData)[] = [];
@@ -569,7 +560,7 @@ export default class Group extends AbleObject<GroupData> {
       { class: tilmeld.Group },
       {
         type: '&',
-        equal: ['enabled', true],
+        ...(andDisabled ? {} : { equal: ['enabled', true] }),
         ref: ['parent', this],
       },
     );
@@ -593,7 +584,7 @@ export default class Group extends AbleObject<GroupData> {
    *
    * @returns The level of the group.
    */
-  public async $getLevel() {
+  public async $getLevel(): Promise<number> {
     const tilmeld = enforceTilmeld(this);
     let group = await tilmeld.Group.factory(this.guid ?? undefined);
     let parent = group.parent;
@@ -609,7 +600,7 @@ export default class Group extends AbleObject<GroupData> {
   }
 
   /**
-   * Gets an array of users in the group.
+   * Gets an array of enabled users in the group.
    *
    * @param descendants Include users in all descendant groups too.
    * @param limit The limit for the query.
@@ -632,10 +623,7 @@ export default class Group extends AbleObject<GroupData> {
         limit,
         offset,
       },
-      {
-        type: '&',
-        equal: ['enabled', true],
-      },
+      { type: '&', equal: ['enabled', true] },
       {
         type: '|',
         ref: [
@@ -845,7 +833,7 @@ export default class Group extends AbleObject<GroupData> {
   public async $save() {
     let tilmeld = enforceTilmeld(this);
     if (this.$data.groupname == null || !this.$data.groupname.trim().length) {
-      return false;
+      throw new BadUsernameError('Groupname must not be empty.');
     }
 
     // Lowercase the domain part.
@@ -1007,11 +995,13 @@ export default class Group extends AbleObject<GroupData> {
       );
       if (currentPrimary != null && !this.$is(currentPrimary)) {
         currentPrimary.defaultPrimary = false;
-        if (
-          this.$skipAcWhenSaving
-            ? !(await currentPrimary.$saveSkipAC())
-            : !(await currentPrimary.$save())
-        ) {
+        try {
+          if (this.$skipAcWhenSaving) {
+            await currentPrimary.$saveSkipAC();
+          } else {
+            await currentPrimary.$save();
+          }
+        } catch (e: any) {
           throw new CouldNotChangeDefaultPrimaryGroupError(
             'Could not change new user primary group from ' +
               `${currentPrimary.groupname}.`,
@@ -1020,45 +1010,43 @@ export default class Group extends AbleObject<GroupData> {
       }
     }
 
-    const transaction = 'tilmeld-save-group-' + (this.guid || nanoid());
-    const nymph = this.$nymph;
-    const tnymph = await nymph.startTransaction(transaction);
-    this.$setNymph(tnymph);
-    tilmeld = enforceTilmeld(this);
-
     let preGuid = this.guid;
     let preCdate = this.cdate;
     let preMdate = this.mdate;
+    return await transaction(
+      this.$nymph,
+      'tilmeld-save-group-' + (this.guid || nanoid()),
+      async (nymph) => {
+        this.$setNymph(nymph);
 
-    try {
-      for (let callback of (this.constructor as typeof Group)
-        .beforeSaveCallbacks) {
-        if (callback) {
-          await callback(this);
+        for (let callback of (this.constructor as typeof Group)
+          .beforeSaveCallbacks) {
+          if (callback) {
+            await callback(this);
+          }
         }
-      }
 
-      let ret = await super.$save();
-      if (ret) {
-        this.$originalGroupname = this.$data.groupname;
-      }
-      for (let callback of (this.constructor as typeof Group)
-        .afterSaveCallbacks) {
-        if (callback) {
-          await callback(this);
+        await super.$save();
+
+        for (let callback of (this.constructor as typeof Group)
+          .afterSaveCallbacks) {
+          if (callback) {
+            await callback(this);
+          }
         }
-      }
-      ret = await tnymph.commit(transaction);
-      this.$setNymph(nymph);
-      return ret;
-    } catch (e: any) {
-      await tnymph.rollback(transaction);
-      this.guid = preGuid;
-      this.cdate = preCdate;
-      this.mdate = preMdate;
-      this.$setNymph(nymph);
-      throw e;
-    }
+      },
+      async (nymph, committed) => {
+        this.$setNymph(nymph);
+
+        if (committed) {
+          this.$originalGroupname = this.$data.groupname;
+        } else {
+          this.guid = preGuid;
+          this.cdate = preCdate;
+          this.mdate = preMdate;
+        }
+      },
+    );
   }
 
   /*
@@ -1066,7 +1054,7 @@ export default class Group extends AbleObject<GroupData> {
    */
   public async $saveSkipAC() {
     this.$skipAcWhenSaving = true;
-    return await this.$save();
+    await this.$save();
   }
 
   public $tilmeldSaveSkipAC() {
@@ -1077,8 +1065,11 @@ export default class Group extends AbleObject<GroupData> {
     return false;
   }
 
+  @transactional
   public async $delete() {
     let tilmeld = enforceTilmeld(this);
+    const User = this.$nymph.getEntityClass(UserClass);
+
     if (!this.$skipAcWhenDeleting && !tilmeld.gatekeeper('tilmeld/admin')) {
       throw new AccessControlError(
         "You don't have the authority to delete groups.",
@@ -1090,105 +1081,64 @@ export default class Group extends AbleObject<GroupData> {
       );
     }
 
-    const transaction = 'tilmeld-delete-group-' + this.guid;
-    const nymph = this.$nymph;
-    const tnymph = await nymph.startTransaction(transaction);
-    this.$setNymph(tnymph);
-    tilmeld = enforceTilmeld(this);
-    const User = tnymph.getEntityClass(UserClass);
-
-    try {
-      for (let callback of (this.constructor as typeof Group)
-        .beforeDeleteCallbacks) {
-        if (callback) {
-          await callback(this);
-        }
+    for (let callback of (this.constructor as typeof Group)
+      .beforeDeleteCallbacks) {
+      if (callback) {
+        await callback(this);
       }
+    }
 
-      // Delete descendants.
-      const descendants = await this.$getDescendants();
-      if (descendants.length) {
-        for (let curGroup of descendants) {
-          if (
-            this.$skipAcWhenDeleting
-              ? !(await curGroup.$deleteSkipAC())
-              : !(await curGroup.$delete())
-          ) {
-            await tnymph.rollback(transaction);
-            this.$setNymph(nymph);
-            return false;
-          }
+    // Delete children.
+    const children = await this.$nymph.getEntities(
+      { class: tilmeld.Group, skipAc: true },
+      { type: '&', ref: ['parent', this] },
+    );
+    if (children.length) {
+      for (let curGroup of children) {
+        if (this.$skipAcWhenDeleting) {
+          await curGroup.$deleteSkipAC();
+        } else {
+          await curGroup.$delete();
         }
       }
+    }
 
-      // Remove users from this primary group.
-      const primaryUsers = await tnymph.getEntities(
-        {
-          class: User,
-          skipAc: true,
-        },
-        {
-          type: '&',
-          ref: ['group', this],
-        },
-      );
-      for (let user of primaryUsers) {
-        delete user.group;
-        if (
-          this.$skipAcWhenDeleting
-            ? !(await user.$saveSkipAC())
-            : !(await user.$save())
-        ) {
-          await tnymph.rollback(transaction);
-          this.$setNymph(nymph);
-          return false;
-        }
+    // Remove users from this primary group.
+    const primaryUsers = await this.$nymph.getEntities(
+      { class: User, skipAc: true },
+      { type: '&', ref: ['group', this] },
+    );
+    for (let user of primaryUsers) {
+      delete user.group;
+      if (this.$skipAcWhenDeleting) {
+        await user.$saveSkipAC();
+      } else {
+        await user.$save();
       }
+    }
 
-      // Remove users from this secondary group.
-      const secondaryUsers = await tnymph.getEntities(
-        {
-          class: User,
-          skipAc: true,
-        },
-        {
-          type: '&',
-          ref: ['groups', this],
-        },
-      );
-      for (let user of secondaryUsers) {
-        user.$delGroup(this);
-        if (
-          this.$skipAcWhenDeleting
-            ? !(await user.$saveSkipAC())
-            : !(await user.$save())
-        ) {
-          await tnymph.rollback(transaction);
-          this.$setNymph(nymph);
-          return false;
-        }
+    // Remove users from this secondary group.
+    const secondaryUsers = await this.$nymph.getEntities(
+      { class: User, skipAc: true },
+      { type: '&', ref: ['groups', this] },
+    );
+    for (let user of secondaryUsers) {
+      user.$delGroup(this);
+      if (this.$skipAcWhenDeleting) {
+        await user.$saveSkipAC();
+      } else {
+        await user.$save();
       }
+    }
 
-      // Delete the group.
-      let success = await super.$delete();
-      if (success) {
-        for (let callback of (this.constructor as typeof Group)
-          .afterDeleteCallbacks) {
-          if (callback) {
-            await callback(this);
-          }
-        }
+    // Delete the group.
+    await super.$delete();
 
-        success = await tnymph.commit(transaction);
-      } else {
-        await tnymph.rollback(transaction);
+    for (let callback of (this.constructor as typeof Group)
+      .afterDeleteCallbacks) {
+      if (callback) {
+        await callback(this);
       }
-      this.$setNymph(nymph);
-      return success;
-    } catch (e: any) {
-      await tnymph.rollback(transaction);
-      this.$setNymph(nymph);
-      throw e;
     }
   }
 
@@ -1197,7 +1147,7 @@ export default class Group extends AbleObject<GroupData> {
    */
   async $deleteSkipAC() {
     this.$skipAcWhenDeleting = true;
-    return await this.$delete();
+    await this.$delete();
   }
 
   $tilmeldDeleteSkipAC() {

package/src/Tilmeld.ts

@@ -230,8 +230,10 @@ export default class Tilmeld implements TilmeldInterface {
               options.class?.factorySync() instanceof User) || // The use is searching for a user and searching is disabled.
               (!tilmeld.config.enableGroupSearch &&
                 options.class?.factorySync() instanceof Group)) && // Or the same, but for a group.
-            (selectors[0] == null || // No selector specified.
+            (selectors.length > 1 || // There's more than one selector.
+              selectors[0] == null || // Or no selector specified.
               selectors[0].type !== '&' || // Or the type is not and.
+              Object.keys(selectors[0]).length > 2 || // Or there's more than one clause.
               (!('guid' in selectors[0]) && !('equal' in selectors[0])) || // Or they're searching for something other than guid or equal.
               ('guid' in selectors[0] &&
                 (!selectors[0].guid?.length ||
@@ -684,20 +686,12 @@ export default class Tilmeld implements TilmeldInterface {
         subSelectors.push({
           type: '&',
           gte: [['acGroup', TilmeldAccessLevels.READ_ACCESS]],
-          selector: [
-            {
-              type: '|',
-              ref: groupRefs,
-            },
-          ],
+          selector: [{ type: '|', ref: groupRefs }],
         });
       }
       // All the acRead, acWrite, and acFull contains.
       if (acContains.length) {
-        subSelectors.push({
-          type: '|',
-          contain: acContains,
-        });
+        subSelectors.push({ type: '|', contain: acContains });
       }
       const selector: FormattedSelector = { type: '|' };
       if (
@@ -1044,10 +1038,7 @@ export default class Tilmeld implements TilmeldInterface {
 
     const user = await this.nymph.getEntity(
       { class: this.User },
-      {
-        type: '&',
-        guid: guid,
-      },
+      { type: '&', guid },
     );
     if (!user || !user.guid) {
       return null;
@@ -1332,24 +1323,4 @@ export default class Tilmeld implements TilmeldInterface {
       await this.authenticate(false, true);
     }
   }
-
-  // /**
-  //  * Sort an array of groups hierarchically.
-  //  *
-  //  * An additional property of the groups can be used to sort them under their
-  //  * parents.
-  //  *
-  //  * @param array The array of groups.
-  //  * @param property The name of the property to sort groups by. Undefined for no additional sorting.
-  //  * @param caseSensitive Sort case sensitively.
-  //  * @param reverse Reverse the sort order.
-  //  */
-  // public static groupSort(
-  //   array: any[],
-  //   property?: string,
-  //   caseSensitive = false,
-  //   reverse = false
-  // ) {
-  //   hsort(array, property, 'parent', caseSensitive, reverse);
-  // }
 }

package/src/User.testArtifacts.ts

@@ -95,7 +95,7 @@ export function UserTest(
         expect(e).toBeInstanceOf(EntityUniqueConstraintError);
       }
 
-      expect(await newUserA.$deleteSkipAC()).toEqual(true);
+      await newUserA.$deleteSkipAC();
 
       tilmeld.config.generatePrimary = true;
     });
@@ -139,7 +139,7 @@ export function UserTest(
         expect(e).toBeInstanceOf(EntityUniqueConstraintError);
       }
 
-      expect(await newUserA.$deleteSkipAC()).toEqual(true);
+      await newUserA.$deleteSkipAC();
 
       tilmeld.config.generatePrimary = true;
     });
@@ -155,7 +155,7 @@ export function UserTest(
       domainAdmin.$password('password');
       domainAdmin.$grant('tilmeld/domain/example.com/admin');
 
-      expect(await domainAdmin.$saveSkipAC()).toEqual(true);
+      await domainAdmin.$saveSkipAC();
 
       // Log in the domain admin.
       await tilmeld.fillSession(domainAdmin);
@@ -169,13 +169,13 @@ export function UserTest(
       domainUser.name = 'New User';
       domainUser.$password('password');
 
-      expect(await domainUser.$save()).toEqual(true);
+      await domainUser.$save();
 
       tilmeld.clearSession();
 
       for (const user of [domainAdmin, domainUser]) {
         if (user.guid != null) {
-          expect(await user.$deleteSkipAC()).toEqual(true);
+          await user.$deleteSkipAC();
         }
       }
     });
@@ -191,7 +191,7 @@ export function UserTest(
       domainAdmin.$password('password');
       domainAdmin.$grant('tilmeld/domain/example.com/admin');
 
-      expect(await domainAdmin.$saveSkipAC()).toEqual(true);
+      await domainAdmin.$saveSkipAC();
 
       // Log in the domain admin.
       await tilmeld.fillSession(domainAdmin);
@@ -218,7 +218,7 @@ export function UserTest(
 
       for (const user of [domainAdmin, domainUser]) {
         if (user.guid != null) {
-          expect(await user.$deleteSkipAC()).toEqual(true);
+          await user.$deleteSkipAC();
         }
       }
     });