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

package/src/Group.ts

@@ -1,6 +1,5 @@
 import {
   EntityData,
-  EntityInterface,
   EntityJson,
   EntityPatch,
   Options,
@@ -10,7 +9,7 @@ import {
 import md5 from 'crypto-js/md5';
 import { difference } from 'lodash';
 
-import type Tilmeld from './Tilmeld';
+import { enforceTilmeld } from './enforceTilmeld';
 import AbleObject from './AbleObject';
 import {
   BadDataError,
@@ -85,7 +84,6 @@ export default class Group extends AbleObject<GroupData> {
   /**
    * The instance of Tilmeld to use for queries.
    */
-  static tilmeld: Tilmeld;
   static ETYPE = 'tilmeld_group';
   static class = 'Group';
 
@@ -116,12 +114,8 @@ export default class Group extends AbleObject<GroupData> {
    */
   private $skipAcWhenSaving = false;
 
-  static async factory(guid?: string): Promise<Group & GroupData> {
-    return (await super.factory(guid)) as Group & GroupData;
-  }
-
   static async factoryGroupname(
-    groupname?: string
+    groupname?: string,
   ): Promise<Group & GroupData> {
     const entity = new this();
     if (groupname != null) {
@@ -132,7 +126,7 @@ export default class Group extends AbleObject<GroupData> {
         {
           type: '&',
           ilike: ['groupname', groupname.replace(/([\\%_])/g, (s) => `\\${s}`)],
-        }
+        },
       );
       if (entity != null) {
         return entity;
@@ -141,19 +135,13 @@ export default class Group extends AbleObject<GroupData> {
     return entity;
   }
 
-  static factorySync(guid?: string): Group & GroupData {
-    return super.factorySync(guid) as Group & GroupData;
-  }
-
-  constructor(guid?: string) {
-    super(guid);
+  constructor() {
+    super();
 
-    if (this.guid == null) {
-      // Defaults.
-      this.$data.enabled = true;
-      this.$data.abilities = [];
-      this.$updateDataProtection();
-    }
+    // Defaults.
+    this.$data.enabled = true;
+    this.$data.abilities = [];
+    this.$updateDataProtection();
   }
 
   /**
@@ -165,16 +153,17 @@ export default class Group extends AbleObject<GroupData> {
    */
   public static async getPrimaryGroups(
     options?: Options,
-    selectors?: Selector[]
+    selectors?: Selector[],
   ) {
-    if (!this.tilmeld.gatekeeper('tilmeld/admin')) {
+    const tilmeld = enforceTilmeld(this);
+    if (!tilmeld.gatekeeper('tilmeld/admin')) {
       throw new Error("You don't have permission to do that.");
     }
 
     return await this.getAssignableGroups(
-      this.tilmeld.config.highestPrimary,
-      { ...options, class: this.tilmeld.Group, return: 'entity' },
-      [...(selectors ?? [])]
+      tilmeld.config.highestPrimary,
+      { ...options, class: tilmeld.Group, return: 'entity' },
+      [...(selectors ?? [])],
     );
   }
 
@@ -187,24 +176,26 @@ export default class Group extends AbleObject<GroupData> {
    */
   public static async getSecondaryGroups(
     options?: Options,
-    selectors?: Selector[]
+    selectors?: Selector[],
   ) {
-    if (!this.tilmeld.gatekeeper('tilmeld/admin')) {
+    const tilmeld = enforceTilmeld(this);
+    if (!tilmeld.gatekeeper('tilmeld/admin')) {
       throw new Error("You don't have permission to do that.");
     }
 
     return await this.getAssignableGroups(
-      this.tilmeld.config.highestSecondary,
-      { ...options, class: this.tilmeld.Group, return: 'entity' },
-      [...(selectors ?? [])]
+      tilmeld.config.highestSecondary,
+      { ...options, class: tilmeld.Group, return: 'entity' },
+      [...(selectors ?? [])],
     );
   }
 
   private static async getAssignableGroups(
     highestParent: string | boolean,
     options: Options<typeof Group>,
-    selectors: Selector[]
+    selectors: Selector[],
   ) {
+    const tilmeld = enforceTilmeld(this);
     let assignableGroups: (Group & GroupData)[] = [];
 
     if (highestParent === false) {
@@ -212,20 +203,28 @@ export default class Group extends AbleObject<GroupData> {
     }
 
     assignableGroups = await this.nymph.getEntities(
-      { ...options, class: this.tilmeld.Group },
-      ...selectors
+      { ...options, class: tilmeld.Group },
+      ...selectors,
     );
     if (highestParent !== true) {
-      assignableGroups = assignableGroups.filter((group) => {
-        let curGroup = group;
-        while (curGroup.parent != null && curGroup.parent.cdate != null) {
-          if (curGroup.parent.guid === highestParent) {
-            return true;
-          }
-          curGroup = curGroup.parent;
-        }
-        return false;
-      });
+      assignableGroups = (
+        await Promise.all(
+          assignableGroups.map(async (group) => {
+            let curGroup = group;
+            let parent = curGroup.parent;
+            await parent?.$wake();
+            while (parent != null && parent?.cdate != null) {
+              if (parent?.guid === highestParent) {
+                return group;
+              }
+              curGroup = parent;
+              parent = curGroup.parent;
+              await parent?.$wake();
+            }
+            return null;
+          }),
+        )
+      ).filter((group) => group != null) as (Group & GroupData)[];
     }
     return assignableGroups;
   }
@@ -245,17 +244,42 @@ export default class Group extends AbleObject<GroupData> {
   }
 
   public $jsonAcceptData(input: EntityJson, allowConflict = false) {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
-    this.$referenceWake();
+    const tilmeld = enforceTilmeld(this);
+    this.$check();
 
     if (
-      input.data.abilities?.indexOf('system/admin') !== -1 &&
-      this.$data.abilities?.indexOf('system/admin') === -1 &&
-      tilmeld.gatekeeper('tilmeld/admin') &&
-      !tilmeld.gatekeeper('system/admin')
+      'abilities' in input.data &&
+      input.data.abilities?.includes('system/admin') !==
+        this.$data.abilities?.includes('system/admin') &&
+      (!tilmeld.currentUser ||
+        !tilmeld.currentUser.abilities?.includes('system/admin'))
     ) {
       throw new BadDataError(
-        "You don't have the authority to make this group a system admin."
+        "You don't have the authority to grant or revoke system/admin.",
+      );
+    }
+
+    if (
+      'abilities' in input.data &&
+      input.data.abilities?.includes('tilmeld/admin') !==
+        this.$data.abilities?.includes('tilmeld/admin') &&
+      (!tilmeld.currentUser ||
+        !tilmeld.currentUser.abilities?.includes('system/admin'))
+    ) {
+      throw new BadDataError(
+        "You don't have the authority to grant or revoke tilmeld/admin.",
+      );
+    }
+
+    if (
+      'abilities' in input.data &&
+      input.data.abilities?.includes('tilmeld/switch') !==
+        this.$data.abilities?.includes('tilmeld/switch') &&
+      (!tilmeld.currentUser ||
+        !tilmeld.currentUser.abilities?.includes('system/admin'))
+    ) {
+      throw new BadDataError(
+        "You don't have the authority to grant or revoke tilmeld/switch.",
       );
     }
 
@@ -263,17 +287,42 @@ export default class Group extends AbleObject<GroupData> {
   }
 
   public $jsonAcceptPatch(patch: EntityPatch, allowConflict = false) {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
-    this.$referenceWake();
+    const tilmeld = enforceTilmeld(this);
+    this.$check();
+
+    if (
+      'abilities' in patch.set &&
+      patch.set.abilities?.includes('system/admin') !==
+        this.$data.abilities?.includes('system/admin') &&
+      (!tilmeld.currentUser ||
+        !tilmeld.currentUser.abilities?.includes('system/admin'))
+    ) {
+      throw new BadDataError(
+        "You don't have the authority to grant or revoke system/admin.",
+      );
+    }
+
+    if (
+      'abilities' in patch.set &&
+      patch.set.abilities?.includes('tilmeld/admin') !==
+        this.$data.abilities?.includes('tilmeld/admin') &&
+      (!tilmeld.currentUser ||
+        !tilmeld.currentUser.abilities?.includes('system/admin'))
+    ) {
+      throw new BadDataError(
+        "You don't have the authority to grant or revoke tilmeld/admin.",
+      );
+    }
 
     if (
-      patch.set.abilities?.indexOf('system/admin') !== -1 &&
-      this.$data.abilities?.indexOf('system/admin') === -1 &&
-      tilmeld.gatekeeper('tilmeld/admin') &&
-      !tilmeld.gatekeeper('system/admin')
+      'abilities' in patch.set &&
+      patch.set.abilities?.includes('tilmeld/switch') !==
+        this.$data.abilities?.includes('tilmeld/switch') &&
+      (!tilmeld.currentUser ||
+        !tilmeld.currentUser.abilities?.includes('system/admin'))
     ) {
       throw new BadDataError(
-        "You don't have the authority to make this group a system admin."
+        "You don't have the authority to grant or revoke tilmeld/switch.",
       );
     }
 
@@ -291,7 +340,7 @@ export default class Group extends AbleObject<GroupData> {
    * @param givenUser User to update protection for. If undefined, will use the currently logged in user.
    */
   public $updateDataProtection(givenUser?: User & UserData) {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
+    const tilmeld = enforceTilmeld(this);
     let user = givenUser ?? tilmeld.User.current();
 
     this.$privateData = [...Group.DEFAULT_PRIVATE_DATA];
@@ -303,8 +352,8 @@ export default class Group extends AbleObject<GroupData> {
 
     if (
       user != null &&
-      ((user.abilities?.indexOf('tilmeld/admin') ?? -1) !== -1 ||
-        (user.abilities?.indexOf('system/admin') ?? -1) !== -1)
+      (user.abilities?.includes('tilmeld/admin') ||
+        user.abilities?.includes('system/admin'))
     ) {
       // Users who can edit groups can see their data.
       this.$privateData = [];
@@ -312,7 +361,7 @@ export default class Group extends AbleObject<GroupData> {
     } else if (
       this.$data.user != null &&
       user != null &&
-      this.$data.user.$is(user)
+      this.$data.user.guid === user.guid
     ) {
       // Users can see their group's data.
       this.$privateData = [];
@@ -325,11 +374,13 @@ export default class Group extends AbleObject<GroupData> {
    * @param group The group, or the group's GUID.
    * @returns True or false.
    */
-  public $isDescendant(givenGroup: (Group & GroupData) | string): boolean {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
+  public async $isDescendant(
+    givenGroup: (Group & GroupData) | string,
+  ): Promise<boolean> {
+    const tilmeld = enforceTilmeld(this);
     let group: Group & GroupData;
     if (typeof givenGroup === 'string') {
-      group = tilmeld.Group.factorySync(givenGroup);
+      group = await tilmeld.Group.factory(givenGroup);
     } else {
       group = givenGroup;
     }
@@ -337,13 +388,15 @@ export default class Group extends AbleObject<GroupData> {
       return false;
     }
     // Check to see if the group is a descendant of the given group.
-    if (this.$data.parent == null) {
+    const parent = this.$data.parent;
+    await parent?.$wake();
+    if (parent == null) {
       return false;
     }
-    if (this.$data.parent.$is(group)) {
+    if (parent.$is(group)) {
       return true;
     }
-    if (this.$data.parent.$isDescendant(group)) {
+    if (await parent.$isDescendant(group)) {
       return true;
     }
     return false;
@@ -355,14 +408,14 @@ export default class Group extends AbleObject<GroupData> {
    * @returns An array of groups.
    */
   public async $getChildren() {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
+    const tilmeld = enforceTilmeld(this);
     return await this.$nymph.getEntities(
       { class: tilmeld.Group },
       {
         type: '&',
         equal: ['enabled', true],
         ref: ['parent', this],
-      }
+      },
     );
   }
 
@@ -373,9 +426,9 @@ export default class Group extends AbleObject<GroupData> {
    * @returns An array of groups.
    */
   public async $getDescendants(
-    andSelf = false
+    andSelf = false,
   ): Promise<(Group & GroupData)[]> {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
+    const tilmeld = enforceTilmeld(this);
     let groups: (Group & GroupData)[] = [];
     const entities = await this.$nymph.getEntities(
       { class: tilmeld.Group },
@@ -383,7 +436,7 @@ export default class Group extends AbleObject<GroupData> {
         type: '&',
         equal: ['enabled', true],
         ref: ['parent', this],
-      }
+      },
     );
     for (let entity of entities) {
       groups = (await entity.$getDescendants(true)).concat(groups);
@@ -394,37 +447,6 @@ export default class Group extends AbleObject<GroupData> {
     return groups;
   }
 
-  /**
-   * Gets an array of the group's descendant groups.
-   *
-   * @param andSelf Include this group in the returned array.
-   * @returns An array of groups.
-   */
-  public $getDescendantsSync(andSelf = false): (Group & GroupData)[] {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
-    let groups: (Group & GroupData)[] = [];
-    let entity: EntityInterface | null;
-    let offset = 0;
-    do {
-      entity = this.$nymph.driver.getEntitySync(
-        { class: tilmeld.Group, offset },
-        {
-          type: '&',
-          equal: ['enabled', true],
-          ref: ['parent', this],
-        }
-      );
-      if (entity != null) {
-        groups = entity.$getDescendantsSync(true).concat(groups);
-      }
-      offset++;
-    } while (entity != null);
-    if (andSelf) {
-      groups.push(this);
-    }
-    return groups;
-  }
-
   /**
    * Get the number of parents the group has.
    *
@@ -436,13 +458,17 @@ export default class Group extends AbleObject<GroupData> {
    *
    * @returns The level of the group.
    */
-  public $getLevel() {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
-    let group = tilmeld.Group.factorySync(this.guid ?? undefined);
+  public async $getLevel() {
+    const tilmeld = enforceTilmeld(this);
+    let group = await tilmeld.Group.factory(this.guid ?? undefined);
+    let parent = group.parent;
+    await parent?.$wake();
     let level = 0;
-    while (group.parent != null && group.parent.cdate != null && level < 1024) {
+    while (parent != null && parent.cdate != null && level < 1024) {
       level++;
-      group = group.parent;
+      group = parent;
+      parent = group.parent;
+      await parent?.$wake();
     }
     return level;
   }
@@ -458,9 +484,9 @@ export default class Group extends AbleObject<GroupData> {
   public async $getUsers(
     descendants = false,
     limit?: number,
-    offset?: number
+    offset?: number,
   ): Promise<(User & UserData)[]> {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
+    const tilmeld = enforceTilmeld(this);
     let groups: (Group & GroupData)[] = [];
     if (descendants) {
       groups = await this.$getDescendants();
@@ -489,7 +515,7 @@ export default class Group extends AbleObject<GroupData> {
             group,
           ]),
         ],
-      }
+      },
     );
   }
 
@@ -502,15 +528,21 @@ export default class Group extends AbleObject<GroupData> {
     result: boolean;
     message: string;
   }> {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
+    const tilmeld = enforceTilmeld(this);
     if (!tilmeld.config.emailUsernames) {
       if (this.$data.groupname == null || !this.$data.groupname.length) {
         return { result: false, message: 'Please specify a groupname.' };
       }
-      if (
-        tilmeld.config.maxUsernameLength > 0 &&
-        this.$data.groupname.length > tilmeld.config.maxUsernameLength
-      ) {
+      if (this.$data.groupname.length < tilmeld.config.minUsernameLength) {
+        return {
+          result: false,
+          message:
+            'Groupnames must be at least ' +
+            tilmeld.config.minUsernameLength +
+            ' characters.',
+        };
+      }
+      if (this.$data.groupname.length > tilmeld.config.maxUsernameLength) {
         return {
           result: false,
           message:
@@ -522,7 +554,7 @@ export default class Group extends AbleObject<GroupData> {
       if (
         difference(
           this.$data.groupname.split(''),
-          tilmeld.config.validChars.split('')
+          tilmeld.config.validChars.split(''),
         ).length
       ) {
         return {
@@ -549,7 +581,7 @@ export default class Group extends AbleObject<GroupData> {
       }
       const test = await this.$nymph.getEntity(
         { class: tilmeld.Group, skipAc: true },
-        selector
+        selector,
       );
       if (test != null) {
         return { result: false, message: 'That groupname is taken.' };
@@ -565,10 +597,16 @@ export default class Group extends AbleObject<GroupData> {
       if (this.$data.groupname == null || !this.$data.groupname.length) {
         return { result: false, message: 'Please specify an email.' };
       }
-      if (
-        tilmeld.config.maxUsernameLength > 0 &&
-        this.$data.groupname.length > tilmeld.config.maxUsernameLength
-      ) {
+      if (this.$data.groupname.length < tilmeld.config.minUsernameLength) {
+        return {
+          result: false,
+          message:
+            'Emails must be at least ' +
+            tilmeld.config.minUsernameLength +
+            ' characters.',
+        };
+      }
+      if (this.$data.groupname.length > tilmeld.config.maxUsernameLength) {
         return {
           result: false,
           message:
@@ -588,7 +626,7 @@ export default class Group extends AbleObject<GroupData> {
    * @returns An object with a boolean 'result' entry and a 'message' entry.
    */
   public async $checkEmail(): Promise<{ result: boolean; message: string }> {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
+    const tilmeld = enforceTilmeld(this);
     if (this.$data.email === '') {
       return { result: true, message: '' };
     }
@@ -610,7 +648,7 @@ export default class Group extends AbleObject<GroupData> {
     }
     const test = await this.$nymph.getEntity(
       { class: tilmeld.Group, skipAc: true },
-      selector
+      selector,
     );
     if (test != null) {
       return {
@@ -627,7 +665,7 @@ export default class Group extends AbleObject<GroupData> {
   }
 
   public async $save() {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
+    const tilmeld = enforceTilmeld(this);
     if (this.$data.groupname == null || !this.$data.groupname.trim().length) {
       return false;
     }
@@ -643,16 +681,22 @@ export default class Group extends AbleObject<GroupData> {
     this.$data.enabled = !!this.$data.enabled;
 
     // Clear empty values.
-    if (this.$data.name === '') {
+    if (this.$data.name === '' || !tilmeld.config.userFields.includes('name')) {
       delete this.$data.name;
     }
-    if (this.$data.email === '') {
+    if (
+      this.$data.email === '' ||
+      !tilmeld.config.userFields.includes('email')
+    ) {
       delete this.$data.email;
     }
     if (this.$data.avatar === '') {
       delete this.$data.avatar;
     }
-    if (this.$data.phone === '') {
+    if (
+      this.$data.phone === '' ||
+      !tilmeld.config.userFields.includes('phone')
+    ) {
       delete this.$data.phone;
     }
     if (this.$data.parent == null) {
@@ -671,10 +715,12 @@ export default class Group extends AbleObject<GroupData> {
       delete this.$data.unverifiedSecondary;
     }
 
-    // Groups should never have 'system/admin' or 'tilmeld/admin' abilities.
+    // Groups should never have 'system/admin', 'tilmeld/admin', or
+    // 'tilmeld/switch' abilities.
     this.$data.abilities = difference(this.$data.abilities ?? [], [
       'system/admin',
       'tilmeld/admin',
+      'tilmeld/switch',
       null,
       undefined,
     ]) as string[];
@@ -684,7 +730,10 @@ export default class Group extends AbleObject<GroupData> {
     if (!unCheck.result) {
       throw new BadUsernameError(unCheck.message);
     }
-    if (!tilmeld.config.emailUsernames) {
+    if (
+      !tilmeld.config.emailUsernames &&
+      tilmeld.config.userFields.includes('email')
+    ) {
       const emCheck = await this.$checkEmail();
       if (!emCheck.result) {
         throw new BadEmailError(emCheck.message);
@@ -692,19 +741,21 @@ export default class Group extends AbleObject<GroupData> {
     }
 
     // Validate group parent. Make sure it's not a descendant of this group.
+    const parent = this.$data.parent;
+    await parent?.$wake();
     if (
-      this.$data.parent &&
-      (this.$data.parent.cdate == null ||
-        this.$is(this.$data.parent) ||
-        this.$data.parent.$isDescendant(this))
+      parent &&
+      (parent.cdate == null ||
+        this.$is(parent) ||
+        (await parent.$isDescendant(this)))
     ) {
       throw new BadDataError(
-        "Group parent can't be itself or descendant of itself."
+        "Group parent can't be itself or descendant of itself.",
       );
     }
 
     try {
-      tilmeld.config.validatorGroup(this);
+      tilmeld.config.validatorGroup(tilmeld, this);
     } catch (e: any) {
       throw new BadDataError(e?.message);
     }
@@ -713,14 +764,14 @@ export default class Group extends AbleObject<GroupData> {
     if (this.$data.defaultPrimary) {
       const currentPrimary = await this.$nymph.getEntity(
         { class: tilmeld.Group },
-        { type: '&', truthy: 'defaultPrimary' }
+        { type: '&', truthy: 'defaultPrimary' },
       );
       if (currentPrimary != null && !this.$is(currentPrimary)) {
         currentPrimary.defaultPrimary = false;
         if (!(await currentPrimary.$save())) {
           throw new CouldNotChangeDefaultPrimaryGroupError(
             'Could not change new user primary group from ' +
-              `${currentPrimary.groupname}.`
+              `${currentPrimary.groupname}.`,
           );
         }
       }
@@ -746,7 +797,7 @@ export default class Group extends AbleObject<GroupData> {
   }
 
   public async $delete() {
-    let tilmeld = this.$nymph.tilmeld as Tilmeld;
+    let tilmeld = enforceTilmeld(this);
     if (!tilmeld.gatekeeper('tilmeld/admin')) {
       throw new BadDataError("You don't have the authority to delete groups.");
     }
@@ -755,7 +806,7 @@ export default class Group extends AbleObject<GroupData> {
     const nymph = this.$nymph;
     const tnymph = await nymph.startTransaction(transaction);
     this.$nymph = tnymph;
-    tilmeld = this.$nymph.tilmeld as Tilmeld;
+    tilmeld = enforceTilmeld(this);
 
     // Delete descendants.
     const descendants = await this.$getDescendants();
@@ -778,7 +829,7 @@ export default class Group extends AbleObject<GroupData> {
       {
         type: '&',
         ref: ['group', this],
-      }
+      },
     );
     for (let user of primaryUsers) {
       delete user.group;
@@ -798,7 +849,7 @@ export default class Group extends AbleObject<GroupData> {
       {
         type: '&',
         ref: ['groups', this],
-      }
+      },
     );
     for (let user of secondaryUsers) {
       user.$delGroup(this);