@nymphjs/tilmeld 1.0.0-alpha.3 → 1.0.0-alpha.33

package/src/User.test.ts

@@ -40,6 +40,14 @@ describe('User', () => {
     return newUser;
   }
 
+  it('new user passes validation', async () => {
+    const validUser = await makeNewUser();
+
+    expect(() => {
+      defaults.validatorUser(validUser);
+    }).not.toThrow();
+  });
+
   it("doesn't allow unknown keys", async () => {
     const invalidUser = await makeNewUser();
 

package/src/User.ts

@@ -24,6 +24,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.
@@ -126,13 +164,28 @@ export type UserData = {
   passwordTemp?: string;
 };
 
+/**
+ * A user data model.
+ *
+ * Written by Hunter Perrin for SciActive.
+ *
+ * @author Hunter Perrin <hperrin@gmail.com>
+ * @copyright SciActive Inc
+ * @see http://nymph.io/
+ */
 export default class User extends AbleObject<UserData> {
   /**
    * The instance of Tilmeld to use for queries.
    */
-  public static tilmeld: Tilmeld;
+  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',
@@ -162,7 +215,7 @@ export default class User extends AbleObject<UserData> {
   ];
   private static DEFAULT_ALLOWLIST_DATA: string[] = [];
 
-  protected $clientEnabledMethods = User.DEFAULT_CLIENT_ENABLED_METHODS;
+  protected $clientEnabledMethods = [...User.DEFAULT_CLIENT_ENABLED_METHODS];
   public static clientEnabledStaticMethods = [
     'current',
     'loginUser',
@@ -170,9 +223,9 @@ export default class User extends AbleObject<UserData> {
     'recover',
     'getClientConfig',
   ];
-  protected $privateData = User.DEFAULT_PRIVATE_DATA;
-  public static searchRestrictedData = User.DEFAULT_PRIVATE_DATA;
-  protected $allowlistData? = User.DEFAULT_ALLOWLIST_DATA;
+  protected $privateData = [...User.DEFAULT_PRIVATE_DATA];
+  public static searchRestrictedData = [...User.DEFAULT_PRIVATE_DATA];
+  protected $allowlistData? = [...User.DEFAULT_ALLOWLIST_DATA];
   protected $allowlistTags?: string[] = [];
 
   /**
@@ -420,7 +473,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.' };
     }
@@ -434,7 +491,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.' };
@@ -449,11 +510,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.' };
   }
@@ -464,7 +546,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.' };
   }
 
@@ -570,9 +675,9 @@ export default class User extends AbleObject<UserData> {
     const tilmeld = this.$nymph.tilmeld as Tilmeld;
     let user = givenUser ?? tilmeld.User.current();
 
-    this.$clientEnabledMethods = User.DEFAULT_CLIENT_ENABLED_METHODS;
-    this.$privateData = User.DEFAULT_PRIVATE_DATA;
-    this.$allowlistData = User.DEFAULT_ALLOWLIST_DATA;
+    this.$clientEnabledMethods = [...User.DEFAULT_CLIENT_ENABLED_METHODS];
+    this.$privateData = [...User.DEFAULT_PRIVATE_DATA];
+    this.$allowlistData = [...User.DEFAULT_ALLOWLIST_DATA];
 
     if (tilmeld.config.emailUsernames) {
       this.$privateData.push('username');
@@ -1114,6 +1219,7 @@ 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;
     if (!tilmeld.config.allowRegistration) {
@@ -1130,6 +1236,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,
@@ -1158,7 +1280,9 @@ export default class User extends AbleObject<UserData> {
 
     // Start transaction.
     const transaction = 'tilmeld-register-' + nanoid();
+    const nymph = this.$nymph;
     const tnymph = await this.$nymph.startTransaction(transaction);
+    this.$nymph = tnymph;
 
     try {
       // Add primary group.
@@ -1182,6 +1306,7 @@ export default class User extends AbleObject<UserData> {
         }
         if (!(await generatedPrimaryGroup.$saveSkipAC())) {
           await tnymph.rollback(transaction);
+          this.$nymph = nymph;
           return {
             result: false,
             loggedin: false,
@@ -1282,6 +1407,7 @@ export default class User extends AbleObject<UserData> {
           generatedPrimaryGroup.user = this;
           if (!(await generatedPrimaryGroup.$saveSkipAC())) {
             await tnymph.rollback(transaction);
+            this.$nymph = nymph;
             return {
               result: false,
               loggedin: false,
@@ -1316,7 +1442,20 @@ export default class User extends AbleObject<UserData> {
           message += "You're now registered and logged in!";
           loggedin = true;
         }
+
+        for (let callback of (this.constructor as typeof User)
+          .afterRegisterCallbacks) {
+          if (callback) {
+            await callback(this, {
+              loggedin,
+              message,
+            });
+          }
+        }
+
         await tnymph.commit(transaction);
+        this.$nymph = nymph;
+
         return {
           result: true,
           loggedin,
@@ -1324,6 +1463,7 @@ export default class User extends AbleObject<UserData> {
         };
       } else {
         await tnymph.rollback(transaction);
+        this.$nymph = nymph;
         return {
           result: false,
           loggedin: false,
@@ -1332,6 +1472,7 @@ export default class User extends AbleObject<UserData> {
       }
     } catch (e: any) {
       await tnymph.rollback(transaction);
+      this.$nymph = nymph;
       throw e;
     }
   }
@@ -1532,7 +1673,9 @@ export default class User extends AbleObject<UserData> {
 
     // Start transaction.
     const transaction = 'tilmeld-save-' + nanoid();
+    const nymph = this.$nymph;
     const tnymph = await this.$nymph.startTransaction(transaction);
+    this.$nymph = tnymph;
 
     if (
       this.$data.group != null &&
@@ -1549,6 +1692,7 @@ export default class User extends AbleObject<UserData> {
         await this.$data.group.$saveSkipAC();
       } catch (e: any) {
         await tnymph.rollback(transaction);
+        this.$nymph = nymph;
         throw e;
       }
     }
@@ -1562,6 +1706,7 @@ export default class User extends AbleObject<UserData> {
       ret = await super.$save();
     } catch (e: any) {
       await tnymph.rollback(transaction);
+      this.$nymph = nymph;
       throw e;
     }
     if (ret) {
@@ -1572,6 +1717,7 @@ export default class User extends AbleObject<UserData> {
           this.guid = preGuid;
           this.cdate = preCdate;
           this.mdate = preMdate;
+          this.$nymph = nymph;
           throw new Error("Couldn't send verification email.");
         }
       }
@@ -1587,6 +1733,7 @@ export default class User extends AbleObject<UserData> {
     } else {
       await tnymph.rollback(transaction);
     }
+    this.$nymph = nymph;
     return ret;
   }
 
@@ -1624,4 +1771,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,5 @@
 import { EmailOptions } from 'email-templates';
+
 import type Tilmeld from '../Tilmeld';
 import Group, { GroupData } from '../Group';
 import User, { UserData } from '../User';
@@ -64,6 +65,35 @@ export interface Config {
    * a concern. Same risks as user search if generatePrimary is true.)
    */
   enableGroupSearch: boolean;
+  /**
+   * A list of UIDs that can be read from the client by anyone. (getUID)
+   *
+   * Note: If you'd like to limit the access to logged in users, give them an
+   *       ability like "uid/get/nameofuid".
+   */
+  clientReadableUIDs: string[];
+  /**
+   * A list of UIDs that can be created from the client by anyone. (newUID)
+   *
+   * Inclusion in this list implies inclusion in clientReadableUIDs.
+   *
+   * Note: If you'd like to limit the access to logged in users, give them an
+   *       ability like "uid/new/nameofuid".
+   */
+  clientEnabledUIDs: string[];
+  /**
+   * A list of UIDs that can be set from the client by anyone. (setUID,
+   * renameUID)
+   *
+   * Inclusion in this list implies inclusion in clientReadableUIDs and
+   * clientEnabledUIDs.
+   *
+   * Note: There is no way to run renameUID from the client.
+   *
+   * Note: If you'd like to limit the access to logged in users, give them an
+   *       ability like "uid/set/nameofuid".
+   */
+  clientSetabledUIDs: string[];
   /**
    * These will be the available fields for users. (Some fields, like username,
    * can't be excluded.)

package/src/conf/defaults.ts

@@ -1,3 +1,4 @@
+import { nymphJoiProps } from '@nymphjs/nymph';
 import path from 'path';
 import jwt from 'jsonwebtoken';
 import { nanoid } from 'nanoid';
@@ -20,6 +21,9 @@ export default {
   allowUsernameChange: true,
   enableUserSearch: false,
   enableGroupSearch: false,
+  clientReadableUIDs: [],
+  clientEnabledUIDs: [],
+  clientSetabledUIDs: [],
   userFields: ['name', 'email', 'phone'],
   regFields: ['name', 'email'],
   verifyEmail: true,
@@ -154,29 +158,8 @@ export default {
     Joi.attempt(
       group.$getValidatable(),
       Joi.object().keys({
-        guid: Joi.alternatives()
-          .try(
-            Joi.any().only().allow(null),
-            Joi.string().trim(false).length(24).hex()
-          )
-          .required(),
-        cdate: Joi.alternatives()
-          .try(Joi.any().only().allow(null), Joi.number())
-          .required(),
-        mdate: Joi.alternatives()
-          .try(Joi.any().only().allow(null), Joi.number())
-          .required(),
-        tags: Joi.array()
-          .items(
-            Joi.string()
-              .pattern(/[\x01-\x1F\x7F]/, {
-                name: 'control characters',
-                invert: true,
-              })
-              .min(1)
-          )
-          .required(),
-        groupname: Joi.string().trim(false).min(1).required(),
+        ...nymphJoiProps,
+        groupname: Joi.string().trim(false).required(),
         enabled: Joi.boolean().required(),
         email: Joi.string()
           .trim(false)
@@ -188,7 +171,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512)
           .required(),
         avatar: Joi.string()
@@ -198,7 +180,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(1024),
         phone: Joi.string()
           .trim(false)
@@ -211,7 +192,6 @@ export default {
               name: 'control characters',
               invert: true,
             })
-            .min(1)
             .max(256)
         ),
         defaultPrimary: Joi.boolean(),
@@ -225,29 +205,8 @@ export default {
     Joi.attempt(
       user.$getValidatable(),
       Joi.object().keys({
-        guid: Joi.alternatives()
-          .try(
-            Joi.any().only().allow(null),
-            Joi.string().trim(false).length(24).hex()
-          )
-          .required(),
-        cdate: Joi.alternatives()
-          .try(Joi.any().only().allow(null), Joi.number())
-          .required(),
-        mdate: Joi.alternatives()
-          .try(Joi.any().only().allow(null), Joi.number())
-          .required(),
-        tags: Joi.array()
-          .items(
-            Joi.string()
-              .pattern(/[\x01-\x1F\x7F]/, {
-                name: 'control characters',
-                invert: true,
-              })
-              .min(1)
-          )
-          .required(),
-        username: Joi.string().trim(false).min(1).required(),
+        ...nymphJoiProps,
+        username: Joi.string().trim(false).required(),
         enabled: Joi.boolean().required(),
         email: Joi.string()
           .trim(false)
@@ -259,7 +218,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512)
           .required(),
         nameMiddle: Joi.string()
@@ -268,7 +226,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512),
         nameLast: Joi.string()
           .trim(false)
@@ -276,7 +233,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512),
         name: Joi.string()
           .trim(false)
@@ -284,7 +240,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(512)
           .required(),
         avatar: Joi.string()
@@ -294,7 +249,6 @@ export default {
             name: 'control characters',
             invert: true,
           })
-          .min(1)
           .max(1024),
         phone: Joi.string()
           .trim(false)
@@ -307,7 +261,6 @@ export default {
               name: 'control characters',
               invert: true,
             })
-            .min(1)
             .max(256)
         ),
         inheritAbilities: Joi.boolean(),
@@ -347,8 +300,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/src/index.ts

@@ -14,6 +14,9 @@ export { Tilmeld };
 
 export * from './Tilmeld.types';
 
+import tilmeldJoiProps from './tilmeldJoiProps';
+export { tilmeldJoiProps };
+
 export * from './User';
 import User from './User';
 export { User };

package/src/tilmeldJoiProps.ts

@@ -0,0 +1,46 @@
+import { TilmeldAccessLevels } from '@nymphjs/nymph';
+import Joi from 'joi';
+
+import User from './User';
+import Group from './Group';
+
+export default {
+  user: Joi.object().instance(User),
+  group: Joi.object().instance(Group),
+  acUser: Joi.number().valid(
+    TilmeldAccessLevels.NO_ACCESS,
+    TilmeldAccessLevels.READ_ACCESS,
+    TilmeldAccessLevels.WRITE_ACCESS,
+    TilmeldAccessLevels.FULL_ACCESS
+  ),
+  acGroup: Joi.number().valid(
+    TilmeldAccessLevels.NO_ACCESS,
+    TilmeldAccessLevels.READ_ACCESS,
+    TilmeldAccessLevels.WRITE_ACCESS,
+    TilmeldAccessLevels.FULL_ACCESS
+  ),
+  acOther: Joi.number().valid(
+    TilmeldAccessLevels.NO_ACCESS,
+    TilmeldAccessLevels.READ_ACCESS,
+    TilmeldAccessLevels.WRITE_ACCESS,
+    TilmeldAccessLevels.FULL_ACCESS
+  ),
+  acRead: Joi.array().items(
+    Joi.alternatives().try(
+      Joi.object().instance(User),
+      Joi.object().instance(Group)
+    )
+  ),
+  acWrite: Joi.array().items(
+    Joi.alternatives().try(
+      Joi.object().instance(User),
+      Joi.object().instance(Group)
+    )
+  ),
+  acFull: Joi.array().items(
+    Joi.alternatives().try(
+      Joi.object().instance(User),
+      Joi.object().instance(Group)
+    )
+  ),
+};