@nymphjs/tilmeld 1.0.0-alpha.9 → 1.0.0-beta.1

package/src/User.ts

@@ -7,12 +7,11 @@ import {
 } from '@nymphjs/nymph';
 import { EmailOptions } from 'email-templates';
 import strtotime from 'locutus/php/datetime/strtotime';
-import { nanoid, customAlphabet } from 'nanoid';
-import { nolookalikesSafe } from 'nanoid-dictionary';
 import Base64 from 'crypto-js/enc-base64';
 import sha256 from 'crypto-js/sha256';
 import md5 from 'crypto-js/md5';
 import { difference } from 'lodash';
+import { humanSecret, nanoid } from '@nymphjs/guid';
 
 import type Tilmeld from './Tilmeld';
 import AbleObject from './AbleObject';
@@ -24,6 +23,44 @@ import {
   EmailChangeRateLimitExceededError,
 } from './errors';
 
+export type EventType =
+  | 'beforeRegister'
+  | 'afterRegister'
+  | 'beforeLogin'
+  | 'afterLogin'
+  | 'beforeLogout'
+  | 'afterLogout';
+/**
+ * Theses are run before the user data checks, so the only checks before are
+ * whether registration is allowed and whether the user is already registered.
+ */
+export type TilmeldBeforeRegisterCallback = (
+  user: User & UserData,
+  data: { password: string; additionalData?: { [k: string]: any } }
+) => Promise<void> | void;
+export type TilmeldAfterRegisterCallback = (
+  user: User & UserData,
+  result: { loggedin: boolean; message: string }
+) => Promise<void> | void;
+/**
+ * These are run after the authentication checks, but before the login action.
+ */
+export type TilmeldBeforeLoginCallback = (
+  user: User & UserData,
+  data: {
+    username: string;
+    password: string;
+    additionalData?: { [k: string]: any };
+  }
+) => void;
+/**
+ * This is run before the transaction is committed, and you can perform
+ * additional functions on the transaction, which is available in `user.$nymph`.
+ */
+export type TilmeldAfterLoginCallback = (user: User & UserData) => void;
+export type TilmeldBeforeLogoutCallback = (user: User & UserData) => void;
+export type TilmeldAfterLogoutCallback = (user: User & UserData) => void;
+
 export type UserData = {
   /**
    * The abilities granted to the user.
@@ -142,6 +179,12 @@ export default class User extends AbleObject<UserData> {
   static tilmeld: Tilmeld;
   static ETYPE = 'tilmeld_user';
   static class = 'User';
+  private static beforeRegisterCallbacks: TilmeldBeforeRegisterCallback[] = [];
+  private static afterRegisterCallbacks: TilmeldAfterRegisterCallback[] = [];
+  private static beforeLoginCallbacks: TilmeldBeforeLoginCallback[] = [];
+  private static afterLoginCallbacks: TilmeldAfterLoginCallback[] = [];
+  private static beforeLogoutCallbacks: TilmeldBeforeLogoutCallback[] = [];
+  private static afterLogoutCallbacks: TilmeldAfterLogoutCallback[] = [];
 
   private static DEFAULT_CLIENT_ENABLED_METHODS = [
     '$checkUsername',
@@ -325,7 +368,7 @@ export default class User extends AbleObject<UserData> {
       }
 
       // Create a unique secret.
-      getUser.recoverSecret = customAlphabet(nolookalikesSafe, 10)();
+      getUser.recoverSecret = humanSecret();
       getUser.recoverSecretDate = Date.now();
       if (!(await getUser.$saveSkipAC())) {
         return { result: false, message: "Couldn't save recovery secret." };
@@ -429,7 +472,11 @@ export default class User extends AbleObject<UserData> {
     };
   }
 
-  public static async loginUser(data: { username: string; password: string }) {
+  public static async loginUser(data: {
+    username: string;
+    password: string;
+    additionalData?: { [k: string]: any };
+  }) {
     if (!('username' in data) || !data.username.length) {
       return { result: false, message: 'Incorrect login/password.' };
     }
@@ -443,7 +490,11 @@ export default class User extends AbleObject<UserData> {
     return result;
   }
 
-  public $login(data: { username: string; password: string }) {
+  public $login(data: {
+    username: string;
+    password: string;
+    additionalData?: { [k: string]: any };
+  }) {
     const tilmeld = this.$nymph.tilmeld as Tilmeld;
     if (this.guid == null) {
       return { result: false, message: 'Incorrect login/password.' };
@@ -458,11 +509,32 @@ export default class User extends AbleObject<UserData> {
       return { result: false, message: 'Incorrect login/password.' };
     }
 
+    try {
+      for (let callback of (this.constructor as typeof User)
+        .beforeLoginCallbacks) {
+        if (callback) {
+          callback(this, data);
+        }
+      }
+    } catch (e: any) {
+      return {
+        result: false,
+        message: e.message,
+      };
+    }
+
     // Authentication was successful, attempt to login.
     if (!tilmeld.login(this, true)) {
       return { result: false, message: 'Incorrect login/password.' };
     }
 
+    for (let callback of (this.constructor as typeof User)
+      .afterLoginCallbacks) {
+      if (callback) {
+        callback(this);
+      }
+    }
+
     // Login was successful.
     return { result: true, message: 'You are logged in.' };
   }
@@ -473,7 +545,30 @@ export default class User extends AbleObject<UserData> {
    */
   public $logout() {
     const tilmeld = this.$nymph.tilmeld as Tilmeld;
+
+    try {
+      for (let callback of (this.constructor as typeof User)
+        .beforeLogoutCallbacks) {
+        if (callback) {
+          callback(this);
+        }
+      }
+    } catch (e: any) {
+      return {
+        result: false,
+        message: e.message,
+      };
+    }
+
     tilmeld.logout();
+
+    for (let callback of (this.constructor as typeof User)
+      .afterLogoutCallbacks) {
+      if (callback) {
+        callback(this);
+      }
+    }
+
     return { result: true, message: 'You have been logged out.' };
   }
 
@@ -1123,8 +1218,9 @@ export default class User extends AbleObject<UserData> {
 
   public async $register(data: {
     password: string;
+    additionalData?: { [k: string]: any };
   }): Promise<{ result: boolean; loggedin: boolean; message: string }> {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
+    let tilmeld = this.$nymph.tilmeld as Tilmeld;
     if (!tilmeld.config.allowRegistration) {
       return {
         result: false,
@@ -1139,6 +1235,22 @@ export default class User extends AbleObject<UserData> {
         message: 'This is already a registered user.',
       };
     }
+
+    try {
+      for (let callback of (this.constructor as typeof User)
+        .beforeRegisterCallbacks) {
+        if (callback) {
+          await callback(this, data);
+        }
+      }
+    } catch (e: any) {
+      return {
+        result: false,
+        loggedin: false,
+        message: e.message,
+      };
+    }
+
     if (!('password' in data) || !data.password.length) {
       return {
         result: false,
@@ -1170,6 +1282,7 @@ export default class User extends AbleObject<UserData> {
     const nymph = this.$nymph;
     const tnymph = await this.$nymph.startTransaction(transaction);
     this.$nymph = tnymph;
+    tilmeld = this.$nymph.tilmeld as Tilmeld;
 
     try {
       // Add primary group.
@@ -1318,19 +1431,40 @@ export default class User extends AbleObject<UserData> {
           tilmeld.config.unverifiedAccess &&
           !madeAdmin
         ) {
-          tilmeld.login(this, true);
+          if (!tilmeld.login(this, true)) {
+            throw new Error('An error occurred trying to log you in.');
+          }
           message +=
             "You're now logged in! An email has been sent to " +
             `${this.$data.email} with a verification link for you to finish ` +
             'registration.';
           loggedin = true;
         } else {
-          tilmeld.login(this, true);
+          if (!tilmeld.login(this, true)) {
+            throw new Error('An error occurred trying to log you in.');
+          }
           message += "You're now registered and logged in!";
           loggedin = true;
         }
-        await tnymph.commit(transaction);
-        this.$nymph = nymph;
+
+        for (let callback of (this.constructor as typeof User)
+          .afterRegisterCallbacks) {
+          if (callback) {
+            await callback(this, {
+              loggedin,
+              message,
+            });
+          }
+        }
+
+        try {
+          await tnymph.commit(transaction);
+          this.$nymph = nymph;
+          this.$nymph.tilmeld?.fillSession(this);
+        } catch (e: any) {
+          throw e;
+        }
+
         return {
           result: true,
           loggedin,
@@ -1353,7 +1487,7 @@ export default class User extends AbleObject<UserData> {
   }
 
   public async $save() {
-    const tilmeld = this.$nymph.tilmeld as Tilmeld;
+    let tilmeld = this.$nymph.tilmeld as Tilmeld;
     if (this.$data.username == null || !this.$data.username.trim().length) {
       return false;
     }
@@ -1551,6 +1685,7 @@ export default class User extends AbleObject<UserData> {
     const nymph = this.$nymph;
     const tnymph = await this.$nymph.startTransaction(transaction);
     this.$nymph = tnymph;
+    tilmeld = this.$nymph.tilmeld as Tilmeld;
 
     if (
       this.$data.group != null &&
@@ -1597,14 +1732,14 @@ export default class User extends AbleObject<UserData> {
         }
       }
 
-      if (tilmeld.User.current(true).$is(this)) {
-        // Update the user in the session cache.
-        tilmeld.fillSession(this);
-      }
-
       this.$descendantGroups = undefined;
       this.$gatekeeperCache = undefined;
       await tnymph.commit(transaction);
+
+      if ((nymph.tilmeld as Tilmeld).User.current(true).$is(this)) {
+        // Update the user in the session cache.
+        (nymph.tilmeld as Tilmeld).fillSession(this);
+      }
     } else {
       await tnymph.rollback(transaction);
     }
@@ -1646,4 +1781,82 @@ export default class User extends AbleObject<UserData> {
     }
     return await super.$delete();
   }
+
+  public static on<T extends EventType>(
+    event: T,
+    callback: T extends 'beforeRegister'
+      ? TilmeldBeforeRegisterCallback
+      : T extends 'afterRegister'
+      ? TilmeldAfterRegisterCallback
+      : T extends 'beforeLogin'
+      ? TilmeldBeforeLoginCallback
+      : T extends 'afterLogin'
+      ? TilmeldAfterLoginCallback
+      : T extends 'beforeLogout'
+      ? TilmeldBeforeLogoutCallback
+      : T extends 'afterLogout'
+      ? TilmeldAfterLogoutCallback
+      : never
+  ) {
+    const prop = (event + 'Callbacks') as T extends 'beforeRegister'
+      ? 'beforeRegisterCallbacks'
+      : T extends 'afterRegister'
+      ? 'afterRegisterCallbacks'
+      : T extends 'beforeLogin'
+      ? 'beforeLoginCallbacks'
+      : T extends 'afterLogin'
+      ? 'afterLoginCallbacks'
+      : T extends 'beforeLogout'
+      ? 'beforeLogoutCallbacks'
+      : T extends 'afterLogout'
+      ? 'afterLogoutCallbacks'
+      : never;
+    if (!(prop in this)) {
+      throw new Error('Invalid event type.');
+    }
+    // @ts-ignore: The callback should always be the right type here.
+    this[prop].push(callback);
+    return () => this.off(event, callback);
+  }
+
+  public static off<T extends EventType>(
+    event: T,
+    callback: T extends 'beforeRegister'
+      ? TilmeldBeforeRegisterCallback
+      : T extends 'afterRegister'
+      ? TilmeldAfterRegisterCallback
+      : T extends 'beforeLogin'
+      ? TilmeldBeforeLoginCallback
+      : T extends 'afterLogin'
+      ? TilmeldAfterLoginCallback
+      : T extends 'beforeLogout'
+      ? TilmeldBeforeLogoutCallback
+      : T extends 'afterLogout'
+      ? TilmeldAfterLogoutCallback
+      : never
+  ) {
+    const prop = (event + 'Callbacks') as T extends 'beforeRegister'
+      ? 'beforeRegisterCallbacks'
+      : T extends 'afterRegister'
+      ? 'afterRegisterCallbacks'
+      : T extends 'beforeLogin'
+      ? 'beforeLoginCallbacks'
+      : T extends 'afterLogin'
+      ? 'afterLoginCallbacks'
+      : T extends 'beforeLogout'
+      ? 'beforeLogoutCallbacks'
+      : T extends 'afterLogout'
+      ? 'afterLogoutCallbacks'
+      : never;
+    if (!(prop in this)) {
+      return false;
+    }
+    // @ts-ignore: The callback should always be the right type here.
+    const i = this[prop].indexOf(callback);
+    if (i > -1) {
+      // @ts-ignore: The callback should always be the right type here.
+      this[prop].splice(i, 1);
+    }
+    return true;
+  }
 }

package/src/conf/d.ts

@@ -1,4 +1,4 @@
-import { EmailOptions } from 'email-templates';
+import { EmailOptions, EmailConfig } from 'email-templates';
 
 import type Tilmeld from '../Tilmeld';
 import Group, { GroupData } from '../Group';
@@ -245,6 +245,18 @@ export interface Config {
    * email sender.
    */
   emailTemplateDir: string;
+  /**
+   * Configure an email object to prepare for sending.
+   *
+   * You can use this, for example, for DKIM signing.
+   *
+   * See: https://github.com/forwardemail/email-templates/blob/v8.0.9/README.md#Options
+   */
+  configEmail: (
+    tilmeld: Tilmeld,
+    options: EmailOptions,
+    user: User & UserData
+  ) => Promise<EmailConfig>;
   /**
    * Send an email to a user. Uses `email-templates` by default.
    *

package/src/conf/defaults.ts

@@ -1,9 +1,10 @@
-import { nymphJoiProps } from '@nymphjs/nymph';
 import path from 'path';
+import { URL } from 'url';
 import jwt from 'jsonwebtoken';
-import { nanoid } from 'nanoid';
 import Email from 'email-templates';
 import Joi from 'joi';
+import { nanoid } from '@nymphjs/guid';
+import { nymphJoiProps } from '@nymphjs/nymph';
 
 import { Config } from './d';
 import User from '../User';
@@ -107,16 +108,21 @@ export default {
     }
   },
   emailTemplateDir: path.join(__dirname, '..', '..', 'emails'),
-  sendEmail: async (tilmeld, options, user) => {
+  configEmail: async (tilmeld, _options, _user) => {
     const appUrl = new URL(tilmeld.config.appUrl);
-    const email = new Email({
+    return {
       message: {
         from: {
           name: tilmeld.config.appName,
           address: `noreply@${appUrl.hostname}`,
         },
       },
-    });
+    };
+  },
+  sendEmail: async (tilmeld, options, user) => {
+    const email = new Email(
+      await tilmeld.config.configEmail(tilmeld, options, user)
+    );
     try {
       const result = await email.send({
         ...options,
@@ -159,7 +165,7 @@ export default {
       group.$getValidatable(),
       Joi.object().keys({
         ...nymphJoiProps,
-        groupname: Joi.string().trim(false).min(1).required(),
+        groupname: Joi.string().trim(false).required(),
         enabled: Joi.boolean().required(),
         email: Joi.string()
           .trim(false)
@@ -171,7 +177,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512)
           .required(),
         avatar: Joi.string()
@@ -181,7 +186,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(1024),
         phone: Joi.string()
           .trim(false)
@@ -194,7 +198,6 @@ export default {
               name: 'control characters',
               invert: true,
             })
-            .min(1)
             .max(256)
         ),
         defaultPrimary: Joi.boolean(),
@@ -209,7 +212,7 @@ export default {
       user.$getValidatable(),
       Joi.object().keys({
         ...nymphJoiProps,
-        username: Joi.string().trim(false).min(1).required(),
+        username: Joi.string().trim(false).required(),
         enabled: Joi.boolean().required(),
         email: Joi.string()
           .trim(false)
@@ -221,7 +224,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512)
           .required(),
         nameMiddle: Joi.string()
@@ -230,7 +232,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512),
         nameLast: Joi.string()
           .trim(false)
@@ -238,7 +239,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512),
         name: Joi.string()
           .trim(false)
@@ -246,7 +246,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512)
           .required(),
         avatar: Joi.string()
@@ -256,7 +255,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(1024),
         phone: Joi.string()
           .trim(false)
@@ -269,7 +267,6 @@ export default {
               name: 'control characters',
               invert: true,
             })
-            .min(1)
             .max(256)
         ),
         inheritAbilities: Joi.boolean(),
@@ -309,8 +306,8 @@ export default {
           })
           .length(10),
         recoverSecretDate: Joi.number(),
-        salt: Joi.string().trim(false).min(1),
-        password: Joi.string().trim(false).min(1).required(),
+        salt: Joi.string().trim(false),
+        password: Joi.string().trim(false).required(),
       }),
       'Invalid User: '
     );

package/tsconfig.json

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