@digitaldefiance/node-express-suite 3.6.13 → 3.6.15

package/src/services/user.ts

@@ -1,2279 +0,0 @@
-import {
-  EmailString,
-  IECIESConfig,
-  MemberType,
-  SecureBuffer,
-  SecureString,
-} from '@digitaldefiance/ecies-lib';
-import {
-  Member as BackendMember,
-  ECIESService,
-  SignatureBuffer,
-} from '@digitaldefiance/node-ecies-lib';
-import {
-  AccountLockedError,
-  AccountStatus,
-  AccountStatusError,
-  DirectChallengeNotEnabledError,
-  EmailInUseError,
-  EmailTokenExpiredError,
-  EmailTokenFailedToSendError,
-  EmailTokenSentTooRecentlyError,
-  EmailTokenType,
-  EmailTokenUsedOrInvalidError,
-  EmailVerifiedError,
-  getSuiteCoreTranslation,
-  IBackupCode,
-  InvalidChallengeResponseError,
-  InvalidCredentialsError,
-  InvalidEmailError,
-  InvalidUsernameError,
-  IRequestUserDTO,
-  ITokenRole,
-  IUserBase,
-  IUserDTO,
-  LoginChallengeExpiredError,
-  PasswordLoginNotEnabledError,
-  PendingEmailVerificationError,
-  PrivateKeyRequiredError,
-  Role,
-  SuiteCoreStringKey,
-  TranslatableSuiteError,
-  TranslatableSuiteHandleableError,
-  UsernameInUseError,
-  UsernameOrEmailRequiredError,
-  UserNotFoundError,
-} from '@digitaldefiance/suite-core-lib';
-import { Wallet } from '@ethereumjs/wallet';
-import { randomBytes } from 'crypto';
-import { ClientSession, Document, ProjectionType, Types } from '@digitaldefiance/mongoose-types';
-import validator from 'validator';
-import { BackupCode } from '../backup-code';
-import { IBaseDocument } from '../documents';
-import { IEmailTokenDocument } from '../documents/email-token';
-import { IMnemonicDocument } from '../documents/mnemonic';
-import { IUserDocument } from '../documents/user';
-import { BaseModelName } from '../enumerations/base-model-name';
-import { Environment } from '../environment';
-import { InvalidNewPasswordError } from '../errors';
-import { MongooseValidationError } from '../errors/mongoose-validation';
-import { ICreateUserBasics } from '../interfaces';
-import { IApplication } from '../interfaces/application';
-import { IUserBackendObject } from '../interfaces/backend-objects/user';
-import { IConstants } from '../interfaces/constants';
-import { IEmailService } from '../interfaces/email-service';
-import { ModelRegistry } from '../model-registry';
-import { convertObjectIdToGenericId } from '../types/id-converters';
-import { debugLog } from '../utils';
-import { BackupCodeService } from './backup-code';
-import { BaseService } from './base';
-import { DirectLoginTokenService } from './direct-login-token';
-import { KeyWrappingService } from './key-wrapping';
-import { MnemonicService } from './mnemonic';
-import { RequestUserService } from './request-user';
-import { RoleService } from './role';
-import { SystemUserService } from './system-user';
-
-type ProjectionObject = Record<string, 0 | 1 | -1 | boolean>;
-
-export class UserService<
-  T,
-  I extends Types.ObjectId | string,
-  D extends Date,
-  S extends string,
-  A extends string,
-  TEnvironment extends Environment = Environment,
-  TConstants extends IConstants = IConstants,
-  TBaseDocument extends IBaseDocument<T, I> = IBaseDocument<T, I>,
-  TUser extends IUserBase<I, D, S, A> = IUserBase<I, D, S, A>,
-  TTokenRole extends ITokenRole<I, D> = ITokenRole<I, D>,
-  TApplication extends IApplication = IApplication,
-> extends BaseService {
-  protected readonly roleService: RoleService<I, D, TTokenRole>;
-  protected readonly eciesService: ECIESService;
-  protected readonly keyWrappingService: KeyWrappingService;
-  protected readonly mnemonicService: MnemonicService;
-  protected readonly emailService: IEmailService;
-  protected readonly backupCodeService: BackupCodeService<
-    I,
-    D,
-    TTokenRole,
-    TApplication
-  >;
-  protected readonly serverUrl: string;
-  protected readonly disableEmailSend: boolean;
-  protected readonly idConverter: (id: string) => I;
-  protected readonly idGenerator: () => I;
-
-  constructor(
-    application: IApplication,
-    roleService: RoleService<I, D, TTokenRole>,
-    emailService: IEmailService,
-    keyWrappingService: KeyWrappingService,
-    backupCodeService: BackupCodeService<I, D, TTokenRole, TApplication>,
-    idConverter?: (id: string) => I,
-    idGenerator?: () => I,
-  ) {
-    super(application);
-    this.roleService = roleService;
-    this.emailService = emailService;
-    this.keyWrappingService = keyWrappingService;
-    this.backupCodeService = backupCodeService;
-    this.serverUrl = application.environment.serverUrl;
-    this.disableEmailSend = application.environment.disableEmailSend;
-    this.idConverter =
-      idConverter ?? ((id: string) => new Types.ObjectId(id) as I);
-    this.idGenerator = idGenerator ?? (() => new Types.ObjectId() as I);
-    const config: IECIESConfig = {
-      curveName: this.application.constants.ECIES.CURVE_NAME,
-      primaryKeyDerivationPath:
-        this.application.constants.ECIES.PRIMARY_KEY_DERIVATION_PATH,
-      mnemonicStrength: this.application.constants.ECIES.MNEMONIC_STRENGTH,
-      symmetricAlgorithm:
-        this.application.constants.ECIES.SYMMETRIC_ALGORITHM_CONFIGURATION,
-      symmetricKeyBits: this.application.constants.ECIES.SYMMETRIC.KEY_BITS,
-      symmetricKeyMode: this.application.constants.ECIES.SYMMETRIC.MODE,
-    };
-    this.eciesService = new ECIESService(config);
-    const mnemonicModel =
-      ModelRegistry.instance.getTypedModel<IMnemonicDocument>(
-        BaseModelName.Mnemonic,
-      );
-    this.mnemonicService = new MnemonicService(
-      mnemonicModel,
-      application.environment.mnemonicHmacSecret,
-      this.application.constants,
-    );
-  }
-
-  public toId(id: string): I {
-    return this.idConverter(id);
-  }
-
-  public generateId(): I {
-    return this.idGenerator();
-  }
-
-  /**
-   * Given a User Document, make a User DTO
-   * @param user a User Document
-   * @returns An IUserDTO
-   */
-  public static userToUserDTO<
-    S extends string,
-    I extends string | Types.ObjectId = Types.ObjectId,
-  >(user: IUserDocument<S, I> | Record<string, unknown>): IUserDTO {
-    return {
-      ...(user instanceof Document ? user.toObject() : user),
-      _id: (user._id instanceof Types.ObjectId
-        ? user._id.toString()
-        : user._id) as string,
-      createdBy: (user.createdBy instanceof Date
-        ? user.createdBy.toString()
-        : user.createdBy) as string,
-      updatedBy: (user.updatedBy instanceof Date
-        ? user.updatedBy.toString()
-        : user.updatedBy) as string,
-      ...(user.lastLogin
-        ? {
-            lastLogin: (user.lastLogin instanceof Date
-              ? user.lastLogin.toString()
-              : user.lastLogin) as string,
-          }
-        : {}),
-      ...(user.deletedBy
-        ? {
-            deletedBy: (user.deletedBy instanceof Date
-              ? user.deletedBy.toString()
-              : user.deletedBy) as string,
-          }
-        : {}),
-    } as IUserDTO;
-  }
-
-  /**
-   * Given a User DTO, reconstitute ids and dates
-   * @param user a User DTO
-   * @returns An IUserBackendObject
-   */
-  public hydrateUserDTOToBackend(user: IUserDTO): IUserBackendObject<S, I> {
-    return {
-      ...user,
-      _id: this.idConverter(user._id),
-      ...(user.lastLogin ? { lastLogin: new Date(user.lastLogin) } : {}),
-      createdAt: new Date(user.createdAt),
-      createdBy: this.idConverter(user.createdBy),
-      updatedAt: new Date(user.updatedAt),
-      updatedBy: this.idConverter(user.updatedBy),
-      ...(user.deletedAt ? { deletedAt: new Date(user.deletedAt) } : {}),
-      ...(user.deletedBy
-        ? {
-            deletedBy: this.idConverter(user.deletedBy),
-          }
-        : {}),
-      ...(user.mnemonicId
-        ? { mnemonicId: this.idConverter(user.mnemonicId) }
-        : {}),
-    } as IUserBackendObject<S, I>;
-  }
-
-  /**
-   * Create a new email token to send to the user for email verification
-   * @param userDoc The user to create the email token for
-   * @param type The type of email token to create
-   * @param session The session to use for the query
-   * @returns The email token document
-   */
-  public async createEmailToken(
-    userDoc: IUserDocument<S, I>,
-    type: EmailTokenType,
-    session?: ClientSession,
-  ): Promise<IEmailTokenDocument> {
-    const EmailTokenModel =
-      ModelRegistry.instance.getTypedModel<IEmailTokenDocument>(
-        BaseModelName.EmailToken,
-      );
-
-    // If we already have a session, use it directly to avoid nested transactions
-    if (session) {
-      const now = new Date();
-      const tokenData = {
-        userId: userDoc._id,
-        type: type,
-        email: userDoc.email,
-        token: randomBytes(
-          this.application.constants.EmailTokenLength,
-        ).toString('hex'),
-        createdAt: now,
-        updatedAt: now,
-        expiresAt: new Date(
-          now.getTime() + this.application.constants.EmailTokenExpiration,
-        ),
-      };
-
-      // Use findOneAndUpdate with upsert to avoid duplicate key errors
-      const emailToken = await EmailTokenModel.findOneAndUpdate(
-        {
-          userId: userDoc._id,
-          email: userDoc.email,
-          type: type,
-        },
-        tokenData,
-        {
-          upsert: true,
-          new: true,
-          session,
-        },
-      );
-
-      if (!emailToken) {
-        throw new TranslatableSuiteError(
-          SuiteCoreStringKey.Error_FailedToCreateEmailToken,
-        );
-      }
-      return emailToken;
-    }
-
-    // Only create a new transaction if no session is provided
-    return await this.withTransaction<IEmailTokenDocument>(
-      async (sess: ClientSession | undefined): Promise<IEmailTokenDocument> => {
-        const now = new Date();
-        const tokenData = {
-          userId: userDoc._id,
-          type: type,
-          email: userDoc.email,
-          token: randomBytes(
-            this.application.constants.EmailTokenLength,
-          ).toString('hex'),
-          createdAt: now,
-          updatedAt: now,
-          expiresAt: new Date(
-            now.getTime() + this.application.constants.EmailTokenExpiration,
-          ),
-        };
-
-        // Use findOneAndUpdate with upsert to avoid duplicate key errors
-        const emailToken = await EmailTokenModel.findOneAndUpdate(
-          {
-            userId: userDoc._id,
-            email: userDoc.email,
-            type: type,
-          },
-          tokenData,
-          {
-            upsert: true,
-            new: true,
-            session: sess,
-          },
-        );
-
-        if (!emailToken) {
-          throw new TranslatableSuiteError(
-            SuiteCoreStringKey.Error_FailedToCreateEmailToken,
-          );
-        }
-        return emailToken;
-      },
-      undefined,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout,
-        retryAttempts: 2,
-      },
-    );
-  }
-
-  /**
-   * Create and send an email token to the user for email verification
-   * @param user The user to send the email token to
-   * @param type The type of email token to send
-   * @param session The session to use for the query
-   * @returns The email token document
-   */
-  public async createAndSendEmailToken(
-    user:
-      | IUserDocument<S, I>
-      | (Pick<IUserDocument<S, I>, keyof IUserDocument<S, I>> & { _id: any }),
-    type: EmailTokenType = EmailTokenType.AccountVerification,
-    session?: ClientSession,
-    debug = false,
-  ): Promise<IEmailTokenDocument> {
-    const emailToken = await this.createEmailToken(user, type, session);
-    try {
-      await this.sendEmailToken(emailToken, session, debug);
-    } catch (error) {
-      // keep parity with previous behavior: continue returning token even if email send fails
-    }
-    return emailToken;
-  }
-
-  /**
-   * Create and send an email token directly within an existing transaction
-   * @param user The user to send the email token to
-   * @param type The type of email token to send
-   * @param session The session to use for the query (required)
-   * @param debug Whether to enable debug logging
-   * @returns The email token document
-   */
-  public async createAndSendEmailTokenDirect(
-    user: IUserDocument<S, I>,
-    type: EmailTokenType = EmailTokenType.AccountVerification,
-    session: ClientSession,
-    debug = false,
-  ): Promise<IEmailTokenDocument> {
-    const EmailTokenModel =
-      ModelRegistry.instance.getTypedModel<IEmailTokenDocument>(
-        BaseModelName.EmailToken,
-      );
-
-    // Create token directly within the existing session using upsert
-    const now = new Date();
-    const tokenData = {
-      userId: user._id,
-      type: type,
-      email: user.email,
-      token: randomBytes(this.application.constants.EmailTokenLength).toString(
-        'hex',
-      ),
-      createdAt: now,
-      updatedAt: now,
-      expiresAt: new Date(
-        now.getTime() + this.application.constants.EmailTokenExpiration,
-      ),
-    };
-
-    // Use findOneAndUpdate with upsert to avoid duplicate key errors
-    const emailToken = await EmailTokenModel.findOneAndUpdate(
-      {
-        userId: user._id,
-        email: user.email,
-        type: type,
-      },
-      tokenData,
-      {
-        upsert: true,
-        new: true,
-        session,
-      },
-    );
-
-    if (!emailToken) {
-      throw new TranslatableSuiteError(
-        SuiteCoreStringKey.Error_FailedToCreateEmailToken,
-      );
-    }
-
-    try {
-      await this.sendEmailToken(emailToken, session, debug);
-    } catch (error) {
-      // Ignore email send errors in direct token creation
-    }
-
-    return emailToken;
-  }
-
-  /**
-   * Send an email token to the user for email verification
-   * @param emailToken The email token to send
-   * @param session The session to use for the query
-   * @returns void
-   */
-  public async sendEmailToken(
-    emailToken: IEmailTokenDocument,
-    session?: ClientSession,
-    debug = false,
-  ): Promise<void> {
-    if (this.disableEmailSend) {
-      debugLog(debug, 'log', 'Email sending disabled for testing');
-      // Still update lastSent and expiration to keep token valid during tests
-      emailToken.lastSent = new Date();
-      emailToken.expiresAt = new Date(
-        Date.now() + this.application.constants.EmailTokenExpiration,
-      );
-      await emailToken.save({ session });
-      return;
-    }
-
-    if (
-      emailToken.lastSent &&
-      emailToken.lastSent.getTime() +
-        this.application.constants.EmailTokenResendInterval >
-        Date.now()
-    ) {
-      throw new EmailTokenSentTooRecentlyError(emailToken.lastSent);
-    }
-
-    let subjectString: SuiteCoreStringKey;
-    let bodyString: SuiteCoreStringKey;
-    let url: string;
-    switch (emailToken.type) {
-      case EmailTokenType.AccountVerification:
-        subjectString = SuiteCoreStringKey.Email_ConfirmationSubjectTemplate;
-        bodyString = SuiteCoreStringKey.Email_ConfirmationBody;
-        url = `${this.serverUrl}/verify-email?token=${emailToken.token}`;
-        break;
-      case EmailTokenType.PasswordReset:
-        subjectString = SuiteCoreStringKey.Email_ResetPasswordSubjectTemplate;
-        bodyString = SuiteCoreStringKey.Email_ResetPasswordBody;
-        url = `${this.serverUrl}/forgot-password?token=${emailToken.token}`;
-        break;
-      case EmailTokenType.LoginRequest:
-        subjectString = SuiteCoreStringKey.Email_LoginRequestSubjectTemplate;
-        bodyString = SuiteCoreStringKey.Email_LoginRequestBody;
-        url = `${this.serverUrl}/challenge?token=${emailToken.token}`;
-        break;
-      case EmailTokenType.MnemonicRecoveryRequest:
-      case EmailTokenType.PrivateKeyRequest:
-      default:
-        throw new TranslatableSuiteError(
-          SuiteCoreStringKey.Error_InvalidEmailTokenType,
-        );
-    }
-    const emailSubject = getSuiteCoreTranslation(subjectString);
-    const emailText = `${getSuiteCoreTranslation(bodyString)}\r\n\r\n${url}`;
-    const emailHtml = `<p>${getSuiteCoreTranslation(
-      bodyString,
-    )}</p><br/><p><a href="${url}">${url}</a></p><p>${getSuiteCoreTranslation(
-      SuiteCoreStringKey.Email_LinkExpiresInTemplate,
-    )}</p>`;
-
-    try {
-      // Use the EmailService to send the email
-      await this.emailService.sendEmail(
-        emailToken.email,
-        emailSubject,
-        emailText,
-        emailHtml,
-      );
-
-      // update last sent/expiration
-      emailToken.lastSent = new Date();
-      emailToken.expiresAt = new Date(
-        Date.now() + this.application.constants.EmailTokenExpiration,
-      );
-      await emailToken.save({ session });
-    } catch (error) {
-      throw new EmailTokenFailedToSendError(emailToken.type);
-    }
-  }
-
-  /**
-   * Find a user by email or username and enforce account status checks
-   * @param email Optional email
-   * @param username Optional username
-   * @param session Optional mongoose session
-   * @throws UsernameOrEmailRequiredError if neither provided
-   * @throws InvalidCredentialsError if not found or deleted
-   * @throws AccountLockedError | PendingEmailVerificationError | AccountStatusError per status
-   */
-  public async findUser(
-    email?: string,
-    username?: string,
-    session?: ClientSession,
-  ): Promise<IUserDocument<S, I>> {
-    if (!email && !username) {
-      throw new UsernameOrEmailRequiredError();
-    }
-    const UserModel = ModelRegistry.instance.getTypedModel<IUserDocument<S, I>>(
-      BaseModelName.User,
-    );
-    let userDoc: IUserDocument<S, I> | null = null;
-
-    try {
-      if (email) {
-        userDoc = await UserModel.findOne({
-          email: email.toLowerCase(),
-        })
-          .session(session ?? null)
-          .exec();
-      } else if (username) {
-        userDoc = await UserModel.findOne({ username })
-          .collation({ locale: 'en', strength: 2 })
-          .session(session ?? null)
-          .exec();
-      }
-    } catch (error) {
-      // Database error in findUser - convert to InvalidCredentialsError for security
-      throw new InvalidCredentialsError();
-    }
-
-    if (!userDoc || userDoc.deletedAt) {
-      if (email) {
-        throw new InvalidEmailError('Missing');
-      }
-      throw new InvalidUsernameError();
-    }
-
-    switch (userDoc.accountStatus) {
-      case AccountStatus.Active:
-        break;
-      case AccountStatus.AdminLock:
-        throw new AccountLockedError();
-      case AccountStatus.PendingEmailVerification:
-        throw new PendingEmailVerificationError();
-      default:
-        throw new AccountStatusError(userDoc.accountStatus);
-    }
-
-    return userDoc as IUserDocument<S, I>;
-  }
-
-  /**
-   * Finds a user record by ID
-   * @param userId The user ID
-   * @param throwIfNotActive Whether to throw if the user is inactive
-   * @param session The active session, if present
-   * @returns The user document
-   */
-  public async findUserById(
-    userId: I,
-    throwIfNotActive: boolean,
-    session?: ClientSession,
-    select?: ProjectionType<IUserDocument<S, I>>,
-  ): Promise<IUserDocument<S, I>> {
-    const UserModel = ModelRegistry.instance.getTypedModel<IUserDocument<S, I>>(
-      BaseModelName.User,
-    );
-    const baseQuery = UserModel.findById(userId).session(session ?? null);
-    if (select) {
-      // Always include fields needed for status checks
-      const merged = this.ensureRequiredFieldsInProjection(select, [
-        'deletedAt',
-        'accountStatus',
-      ]);
-      baseQuery.select(merged);
-    }
-    const userDoc = (await baseQuery.exec()) as IUserDocument<S, I> | null;
-    if (!userDoc || userDoc.deletedAt) {
-      throw new UserNotFoundError();
-    }
-    if (throwIfNotActive) {
-      switch (userDoc.accountStatus) {
-        case AccountStatus.Active:
-          break;
-        case AccountStatus.AdminLock:
-          throw new AccountLockedError();
-        case AccountStatus.PendingEmailVerification:
-          throw new PendingEmailVerificationError();
-        default:
-          throw new AccountStatusError(userDoc.accountStatus);
-      }
-    }
-    return userDoc;
-  }
-
-  /**
-   * Ensure required fields are present in a projection for queries that rely on them.
-   * Supports string and object-style projections. For inclusion projections, adds fields.
-   * For exclusion projections, ensures required fields are not excluded.
-   */
-  private ensureRequiredFieldsInProjection(
-    select: ProjectionType<IUserDocument<S, I>>,
-    required: string[],
-  ): ProjectionType<IUserDocument<S, I>> {
-    if (typeof select === 'string') {
-      const parts = select
-        .split(/\s+/)
-        .map((s) => s.trim())
-        .filter(Boolean);
-      const exclusions = new Set(
-        parts.filter((p) => p.startsWith('-')).map((p) => p.slice(1)),
-      );
-      // Remove exclusions on required fields
-      for (const r of required) {
-        exclusions.delete(r);
-      }
-      const cleaned = parts.filter((p) => !p.startsWith('-'));
-      for (const r of required) {
-        if (!cleaned.includes(r)) cleaned.push(r);
-      }
-      const result = [...cleaned, ...[...exclusions].map((r) => `-${r}`)];
-      return result.join(' ');
-    }
-    if (select && typeof select === 'object') {
-      const proj: ProjectionObject = { ...(select as ProjectionObject) };
-      const values = Object.values(proj);
-      const hasInclusions = values.some((v) => v === 1 || v === true);
-      if (hasInclusions) {
-        for (const r of required) {
-          proj[r] = 1;
-        }
-      } else {
-        const keysToRemove = required.filter(
-          (r) => proj[r] === 0 || proj[r] === false || proj[r] === -1,
-        );
-        keysToRemove.forEach((key) => delete proj[key]);
-      }
-      return proj as ProjectionType<IUserDocument<S, I>>;
-    }
-    return select;
-  }
-
-  /**
-   * Fill in the default values to a user object
-   * @param newUser The user object to fill in
-   * @param createdBy The user ID of the user creating the new user
-   * @returns The filled in user
-   */
-  public fillUserDefaults(
-    newUser: ICreateUserBasics,
-    createdBy: I,
-    backupCodes: Array<IBackupCode>,
-    encryptedMnemonic: string,
-    userId?: I,
-  ): IUserBackendObject<S, I> {
-    return {
-      ...(userId ? { _id: userId } : {}),
-      timezone: 'UTC',
-      ...newUser,
-      email: newUser.email.toLowerCase(),
-      emailVerified: false,
-      darkMode: false,
-      accountStatus: AccountStatus.PendingEmailVerification,
-      siteLanguage: 'en-US' as S,
-      duressPasswords: [],
-      publicKey: '',
-      backupCodes,
-      mnemonicRecovery: encryptedMnemonic,
-      currency: 'USD',
-      directChallenge: true,
-      createdAt: new Date(),
-      createdBy: createdBy,
-      updatedAt: new Date(),
-      updatedBy: createdBy,
-    } as IUserBackendObject<S, I>;
-  }
-
-  /**
-   * Create a new user document from an IUser and unhashed password
-   * @param newUser The user object
-   * @returns The new user document
-   */
-  public async makeUserDoc(newUser: TUser): Promise<IUserDocument<S, I>> {
-    const UserModel = ModelRegistry.instance.getTypedModel<IUserDocument<S, I>>(
-      BaseModelName.User,
-    );
-
-    const newUserDoc: IUserDocument<S, I> = new UserModel(newUser);
-
-    const validationError = newUserDoc.validateSync();
-    if (validationError) {
-      throw new MongooseValidationError(validationError.errors);
-    }
-
-    return newUserDoc;
-  }
-
-  /**
-   * Create a new user.
-   * Do not set createdBy to a new (non-existing) ObjectId unless you also set newUserId to it.
-   * If newUserId is not set, one will be generated.
-   * @param systemUser The system user performing the operation
-   * @param userData Username, email, password in a ICreateUserBasics object
-   * @param createdBy The user id of the user creating the user
-   * @param newUserId the user id of the new user object- usually the createdBy user id.
-   * @param session The session to use for the query
-   * @param debug Whether to log debug information
-   * @param password The password to use for the new user (optional, if not provided, mnemonic will be used)
-   * @returns The new user document
-   */
-  public async newUser(
-    systemUser: BackendMember,
-    userData: ICreateUserBasics,
-    createdBy?: I,
-    newUserId?: I,
-    session?: ClientSession,
-    debug = false,
-    password?: string,
-  ): Promise<{
-    user: IUserDocument<S, I>;
-    mnemonic: string;
-    backupCodes: Array<string>;
-    password?: string;
-  }> {
-    const _newUserId = newUserId ?? this.idGenerator();
-    if (!this.application.constants.UsernameRegex.test(userData.username)) {
-      throw new InvalidUsernameError();
-    }
-    if (password && !this.application.constants.PasswordRegex.test(password)) {
-      throw new InvalidNewPasswordError();
-    }
-
-    const UserModel = ModelRegistry.instance.getTypedModel<IUserDocument<S, I>>(
-      BaseModelName.User,
-    );
-    return await this.withTransaction<{
-      user: IUserDocument<S, I>;
-      backupCodes: Array<string>;
-      mnemonic: string;
-    }>(
-      async (sess: ClientSession | undefined) => {
-        const existingEmail: IUserDocument<S, I> | null =
-          await UserModel.findOne({
-            email: userData.email.toLowerCase(),
-          }).session(sess ?? null);
-        if (existingEmail) {
-          throw new EmailInUseError();
-        }
-        const existingUsername: IUserDocument<S, I> | null =
-          await UserModel.findOne({
-            username: { $regex: new RegExp(`^${userData.username}$`, 'i') },
-          }).session(sess ?? null);
-        if (existingUsername) {
-          throw new UsernameInUseError();
-        }
-
-        let mnemonic: SecureString | undefined;
-        let member: BackendMember | undefined;
-        while (!mnemonic || !member) {
-          try {
-            const { member: newMember, mnemonic: newMnemonic } =
-              BackendMember.newMember(
-                this.eciesService,
-                MemberType.User,
-                userData.username,
-                new EmailString(userData.email),
-                undefined,
-                createdBy ? Buffer.from(String(createdBy), 'hex') : undefined,
-              );
-            // make sure the new mnemonic is not already in the database
-
-            const mnemonicExists = await this.mnemonicService.mnemonicExists(
-              newMnemonic,
-              sess,
-            );
-            if (!mnemonicExists) {
-              member = newMember;
-              mnemonic = newMnemonic;
-            }
-          } catch {
-            // If we fail to create a new member, we will retry until we succeed.
-            // This is to ensure that we do not end up with duplicate mnemonics.
-            debugLog(
-              debug,
-              'warn',
-              'Failed to create a new member, retrying...',
-            );
-          }
-        }
-
-        const backupCodes = BackupCode.generateBackupCodes();
-        const encryptedBackupCodes = await BackupCode.encryptBackupCodes(
-          member,
-          systemUser,
-          backupCodes,
-        );
-        const encryptedMnemonic = member
-          .encryptData(Buffer.from(mnemonic.value ?? '', 'utf-8'))
-          .toString('hex');
-
-        const newUserDoc = new UserModel({
-          ...this.fillUserDefaults(
-            userData,
-            createdBy ?? _newUserId,
-            encryptedBackupCodes,
-            encryptedMnemonic,
-            _newUserId,
-          ),
-          publicKey: member.publicKey.toString('hex'),
-        });
-
-        const validationError = newUserDoc.validateSync();
-        if (validationError) {
-          throw new MongooseValidationError(validationError.errors);
-        }
-
-        // Always add HMAC-only mnemonic doc
-        const newMnemonicDoc = await this.mnemonicService.addMnemonic(
-          mnemonic,
-          sess,
-        );
-        if (newMnemonicDoc) {
-          newUserDoc.mnemonicId = newMnemonicDoc._id as I;
-        }
-
-        // If password provided, wrap the ECIES private key with the password (Option B)
-        if (password) {
-          const passwordSecure = new SecureString(password);
-          try {
-            const priv = new SecureBuffer(member.privateKey!.value);
-            try {
-              const wrapped = this.keyWrappingService.wrapSecret(
-                priv,
-                passwordSecure,
-                this.application.constants,
-              );
-              newUserDoc.passwordWrappedPrivateKey = wrapped;
-            } finally {
-              priv.dispose();
-            }
-          } finally {
-            passwordSecure.dispose();
-          }
-        }
-
-        const savedUserDoc = await newUserDoc.save({ session: sess });
-
-        const memberRoleId = await this.roleService.getRoleIdByName(
-          this.application.constants.MemberRole as Role,
-          sess,
-        );
-
-        if (!memberRoleId) {
-          throw new TranslatableSuiteError(
-            SuiteCoreStringKey.Error_FailedToLookupRoleTemplate,
-            {
-              ROLE: getSuiteCoreTranslation(SuiteCoreStringKey.Common_Member),
-            },
-          );
-        }
-
-        await this.roleService.addUserToRole(
-          memberRoleId,
-          savedUserDoc._id,
-          _newUserId,
-          sess,
-        );
-
-        return {
-          user: savedUserDoc,
-          mnemonic: mnemonic.value ?? '',
-          backupCodes: backupCodes.map((code: BackupCode) => code.value ?? ''),
-          ...(password ? { password } : {}),
-        };
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout * 10,
-      },
-    );
-  }
-
-  /**
-   * Get the backup codes for a user.
-   * Requires the user not be deleted or inactive
-   */
-  public async getEncryptedUserBackupCodes(
-    userId: Types.ObjectId,
-    session?: ClientSession,
-  ): Promise<Array<IBackupCode>> {
-    const userWithCodes = await this.findUserById(
-      convertObjectIdToGenericId<I>(userId),
-      true,
-      session,
-    );
-    return userWithCodes.backupCodes;
-  }
-
-  /**
-   * Resets the given user's backup codes
-   * @param backupUser The user to generate codes for
-   * @param session The current session, if any
-   * @returns A promise of an array of backup codes
-   */
-  public async resetUserBackupCodes(
-    backupUser: BackendMember,
-    systemUser: BackendMember,
-    session?: ClientSession,
-  ): Promise<Array<BackupCode>> {
-    if (!backupUser.hasPrivateKey) {
-      throw new PrivateKeyRequiredError();
-    }
-    const backupCodes = BackupCode.generateBackupCodes();
-    const encryptedBackupCodes = await BackupCode.encryptBackupCodes(
-      backupUser,
-      systemUser,
-      backupCodes,
-    );
-    const UserModel = ModelRegistry.instance.get('User')?.model;
-    return await this.withTransaction<Array<BackupCode>>(
-      async (sess: ClientSession | undefined) => {
-        await UserModel.updateOne(
-          { _id: backupUser.id },
-          { $set: { backupCodes: encryptedBackupCodes } },
-          { session: sess },
-        );
-        return backupCodes;
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout,
-      },
-    );
-  }
-
-  /**
-   * Recover a user's mnemonic from an encrypted mnemonic
-   * @param user The user whose mnemonic to recover
-   * @param encryptedMnemonic The encrypted mnemonic
-   * @returns The recovered mnemonic
-   */
-  public recoverMnemonic(
-    user: BackendMember<any>,
-    encryptedMnemonic: string,
-  ): SecureString {
-    if (!encryptedMnemonic) {
-      throw new TranslatableSuiteHandleableError(
-        SuiteCoreStringKey.MnemonicRecovery_Missing,
-        undefined,
-        undefined,
-        {
-          statusCode: 400,
-        },
-      );
-    }
-
-    return new SecureString(
-      user.decryptData(Buffer.from(encryptedMnemonic, 'hex')).toString('utf-8'),
-    );
-  }
-
-  /**
-   * Make a Member from a user document and optional private key
-   * @param userDoc The user document
-   * @param privateKey Optional private key to load the wallet
-   * @param publicKey Optional public key to override the userDoc public key
-   * @param session The current session, if any
-   * @returns A promise containing the created Member
-   */
-  public async makeUserFromUserDoc(
-    userDoc: IUserDocument<S, I>,
-    privateKey?: SecureBuffer,
-    publicKey?: Buffer,
-    mnemonic?: SecureString,
-    wallet?: Wallet,
-    session?: ClientSession,
-  ): Promise<BackendMember<any>> {
-    const memberType = await this.roleService.getMemberType(userDoc, session);
-    const user = new BackendMember(
-      this.eciesService,
-      memberType,
-      userDoc.username,
-      new EmailString(userDoc.email),
-      publicKey ?? Buffer.from(userDoc.publicKey, 'hex'),
-      privateKey,
-      wallet,
-      userDoc._id,
-      new Date(userDoc.createdAt),
-      new Date(userDoc.updatedAt),
-      userDoc.createdBy,
-    );
-    if (
-      (privateKey?.originalLength ?? -1) > 0 &&
-      user.hasPrivateKey &&
-      !wallet
-    ) {
-      user.loadWallet(
-        mnemonic ?? this.recoverMnemonic(user, userDoc.mnemonicRecovery),
-      );
-    }
-    return user;
-  }
-
-  /**
-   * Challenges a given userDoc with a given mnemonic, returns a system and user Member
-   * @param userDoc The userDoc in question
-   * @param mnemonic The mnemonic to challenge against
-   * @returns A promise containing the user and system Members
-   * @throws InvalidCredentialsError if the challenge fails
-   * @throws AccountLockedError if the account is locked
-   * @throws PendingEmailVerificationError if the email is not verified
-   * @throws AccountStatusError if the account status is invalid
-   */
-  public async challengeUserWithMnemonic(
-    userDoc: IUserDocument<S, I>,
-    mnemonic: SecureString,
-    session?: ClientSession,
-  ): Promise<{
-    userMember: BackendMember;
-    adminMember: BackendMember;
-  }> {
-    try {
-      // Verify provided mnemonic corresponds to the stored mnemonic HMAC (no password required)
-      // This prevents any valid mnemonic from authenticating as another user.
-      const MnemonicModel =
-        ModelRegistry.instance.getTypedModel<IMnemonicDocument>(
-          BaseModelName.Mnemonic,
-        );
-      if (!userDoc.mnemonicId) {
-        throw new InvalidCredentialsError();
-      }
-      const mnemonicDoc = await MnemonicModel.findById(userDoc.mnemonicId)
-        .select('hmac')
-        .session(session ?? null)
-        .lean()
-        .exec();
-      if (!mnemonicDoc) {
-        throw new InvalidCredentialsError();
-      }
-      const computedHmac = this.mnemonicService.getMnemonicHmac(mnemonic);
-      if (computedHmac !== mnemonicDoc.hmac) {
-        throw new InvalidCredentialsError();
-      }
-
-      // Create a Member from the provided mnemonic to get the keys
-      const { wallet } = this.eciesService.walletAndSeedFromMnemonic(mnemonic);
-      const privateKey = wallet.getPrivateKey();
-      const publicKey = wallet.getPublicKey();
-      const publicKeyWithPrefix = Buffer.concat([
-        Buffer.from([this.application.constants.ECIES.PUBLIC_KEY_MAGIC]),
-        publicKey,
-      ]);
-      const userMember = await this.makeUserFromUserDoc(
-        userDoc,
-        new SecureBuffer(privateKey),
-        publicKeyWithPrefix,
-        mnemonic,
-        wallet,
-        session,
-      );
-
-      // Verify the public key matches the stored userDoc public key
-      if (userMember.publicKey.toString('hex') !== userDoc.publicKey) {
-        throw new InvalidCredentialsError();
-      }
-
-      // Generate a nonce challenge to verify they can decrypt with their key
-      const adminMember = SystemUserService.getSystemUser(
-        this.application.environment,
-        this.application.constants,
-      );
-      const nonce = randomBytes(32);
-      const signature = adminMember.sign(nonce);
-      const payload = Buffer.concat([nonce, signature]);
-
-      const encryptedPayload = userMember.encryptData(payload);
-      const decryptedPayload = userMember.decryptData(encryptedPayload);
-
-      // Verify the server's signature on the nonce
-      const decryptedNonce = decryptedPayload.subarray(0, 32);
-      const decryptedSignature = decryptedPayload.subarray(32);
-
-      const isSignatureValid = adminMember.verify(
-        decryptedSignature as SignatureBuffer,
-        decryptedNonce,
-      );
-
-      if (!isSignatureValid || !nonce.equals(decryptedNonce)) {
-        throw new InvalidCredentialsError();
-      }
-
-      return {
-        userMember,
-        adminMember: adminMember,
-      };
-    } catch (error) {
-      if (
-        error instanceof InvalidCredentialsError ||
-        error instanceof AccountLockedError ||
-        error instanceof PendingEmailVerificationError ||
-        error instanceof AccountStatusError
-      ) {
-        throw error;
-      }
-      throw new InvalidCredentialsError();
-    }
-  }
-
-  /**
-   * Validates a login challenge response
-   * @param challengeResponse The challenge response bytes in hex
-   * @param email The email address of the user
-   * @param username The username of the user
-   * @param session The mongo session for the query
-   * @returns A promise that resolves to the user document, user member, and system member
-   */
-  public async loginWithChallengeResponse(
-    challengeResponse: string,
-    email?: string,
-    username?: string,
-    session?: ClientSession,
-  ): Promise<{
-    userDoc: IUserDocument<S, I>;
-    userMember: BackendMember;
-    adminMember: BackendMember;
-  }> {
-    const challengeBuffer = Buffer.from(challengeResponse, 'hex');
-    // validate the expected challenge response length (8 + 32 + 64 = 104 bytes)
-    if (
-      challengeBuffer.length !=
-      this.application.constants.DirectLoginChallengeLength
-    ) {
-      throw new InvalidChallengeResponseError();
-    }
-    // disassemble the challengeResponse into time, nonce, signature
-    const time = challengeBuffer.subarray(0, 8); // 16 hex characters
-    const nonce = challengeBuffer.subarray(8, 40); // 64 hex characters
-    const signature = challengeBuffer.subarray(40); // 65 * 2 hex characters
-
-    const timeMs = parseInt(time.toString('hex'), 16);
-    if (
-      new Date().getTime() - timeMs >
-      this.application.constants.LoginChallengeExpiration
-    ) {
-      throw new LoginChallengeExpiredError();
-    }
-
-    const userDoc = await this.findUser(email, username, session);
-    if (!userDoc && email) {
-      throw new InvalidEmailError('Missing');
-    } else if (!userDoc) {
-      throw new InvalidUsernameError();
-    }
-    // re-sign the time + nonce and check if the signature matches
-    const adminMember = SystemUserService.getSystemUser(
-      this.application.environment,
-      this.application.constants,
-    );
-    const timeAndNonce = Buffer.concat([time, nonce]);
-    const expectedSignature = adminMember.sign(timeAndNonce);
-    if (expectedSignature.toString('hex') !== signature.toString('hex')) {
-      throw new InvalidChallengeResponseError();
-    }
-
-    const userMember = await this.makeUserFromUserDoc(
-      userDoc,
-      undefined,
-      undefined,
-      undefined,
-      undefined,
-      session,
-    );
-
-    return {
-      userDoc,
-      userMember,
-      adminMember: adminMember,
-    };
-  }
-
-  /**
-   * Authenticate a user with client-verified challenge (skips server-side challenge)
-   * @returns The authenticated user document.
-   */
-  public async loginWithClientVerifiedChallenge(
-    usernameOrEmail: string,
-    mnemonic: SecureString,
-    session?: ClientSession,
-  ): Promise<{
-    userDoc: IUserDocument<S, I>;
-    userMember: BackendMember;
-    adminMember: BackendMember;
-  }> {
-    const UserModel = this.application.getModel<IUserDocument<S, I>>(
-      BaseModelName.User,
-    );
-    const userQuery = validator.isEmail(usernameOrEmail)
-      ? UserModel.findOne({ email: usernameOrEmail.toLowerCase() }).select(
-          '_id username email accountStatus deletedAt mnemonicId publicKey passwordWrappedPrivateKey',
-        )
-      : UserModel.findOne({ username: usernameOrEmail })
-          .collation({ locale: 'en', strength: 2 })
-          .select(
-            '_id username email accountStatus deletedAt mnemonicId publicKey passwordWrappedPrivateKey',
-          );
-    const userDoc = await userQuery.session(session ?? null);
-
-    if (!userDoc || userDoc.deletedAt) {
-      throw new InvalidCredentialsError();
-    }
-
-    // Check account status
-    switch (userDoc.accountStatus) {
-      case AccountStatus.Active:
-        break;
-      case AccountStatus.AdminLock:
-        throw new AccountLockedError();
-      case AccountStatus.PendingEmailVerification:
-        throw new PendingEmailVerificationError();
-      default:
-        throw new AccountStatusError(userDoc.accountStatus);
-    }
-
-    // Verify mnemonic matches user (simplified verification)
-    try {
-      const MnemonicModel = this.application.getModel<IMnemonicDocument>(
-        BaseModelName.Mnemonic,
-      );
-      if (!userDoc.mnemonicId) {
-        throw new InvalidCredentialsError();
-      }
-      const mnemonicDoc = await MnemonicModel.findById(userDoc.mnemonicId)
-        .select('hmac')
-        .session(session ?? null)
-        .lean()
-        .exec();
-      if (!mnemonicDoc) {
-        throw new InvalidCredentialsError();
-      }
-      const computedHmac = this.mnemonicService.getMnemonicHmac(mnemonic);
-      if (computedHmac !== mnemonicDoc.hmac) {
-        throw new InvalidCredentialsError();
-      }
-
-      // Create Member from mnemonic
-      const { wallet } = this.eciesService.walletAndSeedFromMnemonic(mnemonic);
-      const privateKey = wallet.getPrivateKey();
-      const publicKey = wallet.getPublicKey();
-      const publicKeyWithPrefix = Buffer.concat([
-        Buffer.from([this.application.constants.ECIES.PUBLIC_KEY_MAGIC]),
-        publicKey,
-      ]);
-      const userMember = await this.makeUserFromUserDoc(
-        userDoc,
-        new SecureBuffer(privateKey),
-        publicKeyWithPrefix,
-        mnemonic,
-        wallet,
-        session,
-      );
-
-      // Verify public key matches
-      if (userMember.publicKey.toString('hex') !== userDoc.publicKey) {
-        throw new InvalidCredentialsError();
-      }
-
-      const adminMember = SystemUserService.getSystemUser(
-        this.application.environment,
-        this.application.constants,
-      );
-
-      return {
-        userMember,
-        adminMember,
-        userDoc,
-      };
-    } catch (error) {
-      if (
-        error instanceof InvalidCredentialsError ||
-        error instanceof AccountLockedError ||
-        error instanceof PendingEmailVerificationError ||
-        error instanceof AccountStatusError
-      ) {
-        throw error;
-      }
-      throw new InvalidCredentialsError();
-    }
-  }
-
-  /**
-   * Authenticate a user with their mnemonic.
-   * @returns The authenticated user document.
-   */
-  public async loginWithMnemonic(
-    usernameOrEmail: string,
-    mnemonic: SecureString,
-    session?: ClientSession,
-  ): Promise<{
-    userDoc: IUserDocument<S, I>;
-    userMember: BackendMember;
-    adminMember: BackendMember;
-  }> {
-    const UserModel = ModelRegistry.instance.getTypedModel<IUserDocument<S, I>>(
-      BaseModelName.User,
-    );
-    const userQuery = validator.isEmail(usernameOrEmail)
-      ? UserModel.findOne({ email: usernameOrEmail.toLowerCase() }).select(
-          '_id username email accountStatus deletedAt mnemonicId publicKey passwordWrappedPrivateKey',
-        )
-      : UserModel.findOne({ username: usernameOrEmail })
-          .collation({ locale: 'en', strength: 2 })
-          .select(
-            '_id username email accountStatus deletedAt mnemonicId publicKey passwordWrappedPrivateKey',
-          );
-    const userDoc = await userQuery.session(session ?? null);
-
-    if (!userDoc || userDoc.deletedAt) {
-      throw new InvalidCredentialsError();
-    }
-
-    // Check account status
-    switch (userDoc.accountStatus) {
-      case AccountStatus.Active:
-        break;
-      case AccountStatus.AdminLock:
-        throw new AccountLockedError();
-      case AccountStatus.PendingEmailVerification:
-        throw new PendingEmailVerificationError();
-      default:
-        throw new AccountStatusError(userDoc.accountStatus);
-    }
-
-    const challengeResponse = await this.challengeUserWithMnemonic(
-      userDoc,
-      mnemonic,
-      session,
-    );
-    return { ...challengeResponse, userDoc };
-  }
-
-  /**
-   * Authenticate a user with their password (for key-wrapped accounts).
-   * @returns The authenticated user document.
-   */
-  public async loginWithPassword(
-    usernameOrEmail: string,
-    password: string,
-    session?: ClientSession,
-  ): Promise<{
-    userDoc: IUserDocument<S, I>;
-    userMember: BackendMember;
-    adminMember: BackendMember;
-  }> {
-    const UserModel = this.application.getModel<IUserDocument<S, I>>(
-      BaseModelName.User,
-    );
-    const query = validator.isEmail(usernameOrEmail)
-      ? UserModel.findOne({ email: usernameOrEmail.toLowerCase() })
-      : UserModel.findOne({ username: usernameOrEmail }).collation({
-          locale: 'en',
-          strength: 2,
-        });
-
-    const userDoc: IUserDocument<S, I> | null = await query
-      .session(session ?? null)
-      .exec();
-
-    if (!userDoc || userDoc.deletedAt) {
-      throw new InvalidCredentialsError();
-    }
-
-    // Check account status
-    switch (userDoc.accountStatus) {
-      case AccountStatus.Active:
-        break;
-      case AccountStatus.AdminLock:
-        throw new AccountLockedError();
-      case AccountStatus.PendingEmailVerification:
-        throw new PendingEmailVerificationError();
-      default:
-        throw new AccountStatusError(userDoc.accountStatus);
-    }
-
-    // Check if user has password-based authentication set up (Option B requires passwordWrappedPrivateKey)
-    if (!userDoc.passwordWrappedPrivateKey || !userDoc.mnemonicId) {
-      throw new PasswordLoginNotEnabledError();
-    }
-    // Unwrap password-wrapped private key and complete challenge with possession of private key
-    const unwrapped = await this.keyWrappingService.unwrapSecretAsync(
-      userDoc.passwordWrappedPrivateKey!,
-      password,
-      this.application.constants,
-    );
-
-    // Build user member with unwrapped private key to decrypt challenge
-    // Note: userMember now owns the unwrapped SecureBuffer, so we don't dispose it here
-    const userMember = await this.makeUserFromUserDoc(
-      userDoc,
-      unwrapped,
-      undefined,
-      undefined,
-      undefined,
-      session,
-    );
-
-    // Generate a nonce challenge signed by system
-    const adminMember = SystemUserService.getSystemUser(
-      this.application.environment,
-      this.application.constants,
-    );
-    const nonce = randomBytes(32);
-    const signature = adminMember.sign(nonce);
-    const payload = Buffer.concat([nonce, signature]);
-
-    const encryptedPayload = userMember.encryptData(payload);
-    const decryptedPayload = userMember.decryptData(encryptedPayload);
-
-    const decryptedNonce = decryptedPayload.subarray(0, 32);
-    const decryptedSignature = decryptedPayload.subarray(32);
-
-    const isSignatureValid = adminMember.verify(
-      decryptedSignature as SignatureBuffer,
-      decryptedNonce,
-    );
-    if (!isSignatureValid || !nonce.equals(decryptedNonce)) {
-      throw new InvalidCredentialsError();
-    }
-    return { userDoc, userMember, adminMember: adminMember };
-  }
-
-  /**
-   * Re-send a previously sent email token
-   * @param userId The user id
-   * @param session The session to use for the query
-   * @returns void
-   * @throws EmailTokenUsedOrInvalidError
-   */
-  public async resendEmailToken(
-    userId: string,
-    type: EmailTokenType,
-    session?: ClientSession,
-    debug = false,
-  ): Promise<void> {
-    const EmailTokenModel =
-      ModelRegistry.instance.getTypedModel<IEmailTokenDocument>(
-        BaseModelName.EmailToken,
-      );
-    return await this.withTransaction<void>(
-      async (sess: ClientSession | undefined) => {
-        // look up the most recent email token for a given user, then send it
-        const emailToken: IEmailTokenDocument | null =
-          await EmailTokenModel.findOne({
-            userId,
-            type,
-            expiresAt: { $gt: new Date() },
-          })
-            .session(sess ?? null)
-            .sort({ createdAt: -1 })
-            .limit(1);
-
-        if (!emailToken) {
-          throw new EmailTokenUsedOrInvalidError();
-        }
-
-        await this.sendEmailToken(emailToken, sess, debug);
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout * 5,
-      },
-    );
-  }
-
-  /**
-   * Verify the email token and update the user's account status
-   * @param emailToken The email token to verify
-   * @param session The session to use for the query
-   * @returns void
-   * @throws EmailTokenUsedOrInvalidError
-   * @throws EmailTokenExpiredError
-   * @throws EmailVerifiedError
-   * @throws UserNotFoundError
-   */
-  public async verifyAccountTokenAndComplete(
-    emailToken: string,
-    session?: ClientSession,
-  ): Promise<void> {
-    let alreadyVerified = false;
-
-    await this.withTransaction<void>(
-      async (sess: ClientSession | undefined) => {
-        const EmailTokenModel =
-          ModelRegistry.instance.getTypedModel<IEmailTokenDocument>(
-            BaseModelName.EmailToken,
-          );
-        const UserModel = ModelRegistry.instance.getTypedModel<
-          IUserDocument<S, I>
-        >(BaseModelName.User);
-        const token: IEmailTokenDocument | null = await this.findEmailToken(
-          emailToken,
-          EmailTokenType.AccountVerification,
-          sess,
-        );
-
-        if (!token) {
-          throw new EmailTokenUsedOrInvalidError();
-        }
-
-        if (token.expiresAt < new Date()) {
-          await EmailTokenModel.deleteOne({ _id: token._id }).session(
-            sess ?? null,
-          );
-          throw new EmailTokenExpiredError();
-        }
-
-        const user: IUserDocument<S, I> | null = await UserModel.findById(
-          token.userId,
-        ).session(sess ?? null);
-
-        if (!user || user.deletedAt) {
-          throw new UserNotFoundError();
-        }
-
-        if (user.emailVerified) {
-          // Delete the token and mark to throw error after transaction commits
-          await EmailTokenModel.deleteOne({ _id: token._id }).session(
-            sess ?? null,
-          );
-          alreadyVerified = true;
-          return;
-        }
-
-        // set user email to token email and mark as verified
-        user.email = token.email;
-        user.emailVerified = true;
-        user.accountStatus = AccountStatus.Active;
-        user.updatedBy = user._id;
-        await user.save({ session: sess });
-
-        // Delete the token after successful verification
-        await EmailTokenModel.deleteOne({ _id: token._id }).session(
-          sess ?? null,
-        );
-
-        // add the user to the member role
-        const memberRoleId = await this.roleService.getRoleIdByName(
-          this.application.constants.MemberRole as Role,
-          sess,
-        );
-        if (memberRoleId) {
-          await this.roleService.addUserToRole(
-            memberRoleId,
-            user._id,
-            user._id,
-            sess,
-          );
-        } else {
-          throw new Error('Member role not found');
-        }
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout * 5,
-      },
-    );
-
-    if (alreadyVerified) {
-      throw new EmailVerifiedError(409);
-    }
-  }
-
-  /**
-   * Validate the email token
-   * @param token The token to validate
-   * @param restrictType The type of email token to validate (or throw)
-   * @param session The session to use for the query
-   * @returns void
-   * @throws EmailTokenUsedOrInvalidError
-   */
-  public async validateEmailToken(
-    token: string,
-    restrictType?: EmailTokenType,
-    session?: ClientSession,
-  ): Promise<void> {
-    return await this.withTransaction<void>(
-      async (ses: ClientSession | undefined) => {
-        const EmailTokenModel = this.application.getModel<IEmailTokenDocument>(
-          BaseModelName.EmailToken,
-        );
-        const emailToken = await EmailTokenModel.findOne({
-          token,
-          ...(restrictType ? { type: EmailTokenType.PasswordReset } : {}),
-        }).session(ses ?? null);
-
-        if (!emailToken) {
-          throw new EmailTokenUsedOrInvalidError();
-        } else if (emailToken.expiresAt < new Date()) {
-          await EmailTokenModel.deleteOne({ _id: emailToken._id }).session(
-            ses ?? null,
-          );
-          throw new EmailTokenExpiredError();
-        }
-
-        // nothing else to do here, token is valid
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout * 5,
-      },
-    );
-  }
-
-  /**
-   * Updates the user's language
-   * @param userId - The ID of the user
-   * @param newLanguage - The new language
-   * @param session - The session to use for the query
-   * @returns The updated user
-   */
-  public async updateSiteLanguage(
-    userId: string,
-    newLanguage: string,
-    session?: ClientSession,
-  ): Promise<IRequestUserDTO> {
-    return await this.withTransaction<IRequestUserDTO>(
-      async (sess: ClientSession | undefined) => {
-        const UserModel = ModelRegistry.instance.getTypedModel<
-          IUserDocument<S, I>
-        >(BaseModelName.User);
-        const userDoc = await UserModel.findByIdAndUpdate(
-          this.idConverter(userId),
-          {
-            siteLanguage: newLanguage,
-          },
-          { new: true },
-        ).session(sess ?? null);
-        if (!userDoc) {
-          throw new UserNotFoundError();
-        }
-        const roles = await this.roleService.getUserRoles(userDoc._id);
-        const tokenRoles = this.roleService.rolesToTokenRoles(roles);
-        return RequestUserService.makeRequestUserDTO(userDoc, tokenRoles);
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout * 5,
-      },
-    );
-  }
-
-  /**
-   * Updates the user's Dark Mode preference
-   * @param userId - The ID of the user
-   * @param newDarkMode - The new Dark Mode preference
-   * @param session - The session to use for the query
-   * @returns The updated user
-   */
-  public async updateDarkMode(
-    userId: string,
-    newDarkMode: boolean,
-    session?: ClientSession,
-  ): Promise<IRequestUserDTO> {
-    return await this.withTransaction<IRequestUserDTO>(
-      async (sess: ClientSession | undefined) => {
-        const UserModel = ModelRegistry.instance.getTypedModel<
-          IUserDocument<S, I>
-        >(BaseModelName.User);
-        const userDoc = await UserModel.findByIdAndUpdate(
-          this.idConverter(userId),
-          {
-            darkMode: newDarkMode,
-          },
-          { new: true },
-        ).session(sess ?? null);
-        if (!userDoc) {
-          throw new UserNotFoundError();
-        }
-        const roles = await this.roleService.getUserRoles(userDoc._id);
-        const tokenRoles = this.roleService.rolesToTokenRoles(roles);
-        return RequestUserService.makeRequestUserDTO(userDoc, tokenRoles);
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout * 5,
-      },
-    );
-  }
-
-  /**
-   * Updates multiple user settings at once
-   * @param userId - The ID of the user
-   * @param settings - Object containing settings to update
-   * @param session - The session to use for the query
-   * @returns The updated user
-   */
-  public async updateUserSettings(
-    userId: string,
-    settings: {
-      email?: string;
-      timezone?: string;
-      siteLanguage?: string;
-      currency?: string;
-      darkMode?: boolean;
-      directChallenge?: boolean;
-    },
-    session?: ClientSession,
-  ): Promise<IRequestUserDTO> {
-    return await this.withTransaction<IRequestUserDTO>(
-      async (sess: ClientSession | undefined) => {
-        const UserModel = ModelRegistry.instance.getTypedModel<
-          IUserDocument<S, I>
-        >(BaseModelName.User);
-        const userDoc = await UserModel.findById(
-          this.idConverter(userId),
-        ).session(sess ?? null);
-        if (!userDoc) {
-          throw new UserNotFoundError();
-        }
-
-        // Check if email is changing and if it's already in use
-        if (
-          settings.email &&
-          settings.email.toLowerCase() !== userDoc.email.toLowerCase()
-        ) {
-          const existingUser = await UserModel.findOne({
-            email: settings.email.toLowerCase(),
-            _id: { $ne: userDoc._id },
-          }).session(sess ?? null);
-          if (existingUser) {
-            throw new EmailInUseError();
-          }
-          // Send verification email for new address
-          userDoc.email = settings.email.toLowerCase();
-          await this.createAndSendEmailTokenDirect(
-            userDoc,
-            EmailTokenType.AccountVerification,
-            sess!,
-            this.application.environment.debug,
-          );
-        }
-
-        // Update other settings
-        if (settings.timezone !== undefined)
-          userDoc.timezone = settings.timezone;
-        if (settings.siteLanguage !== undefined)
-          userDoc.siteLanguage = settings.siteLanguage as S;
-        if (settings.darkMode !== undefined)
-          userDoc.darkMode = settings.darkMode;
-        if (settings.currency !== undefined)
-          userDoc.currency = settings.currency;
-        if (settings.directChallenge !== undefined)
-          userDoc.directChallenge = settings.directChallenge;
-
-        await userDoc.save({ session: sess });
-
-        const roles = await this.roleService.getUserRoles(userDoc._id);
-        const tokenRoles = this.roleService.rolesToTokenRoles(roles);
-        return RequestUserService.makeRequestUserDTO(userDoc, tokenRoles);
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout * 5,
-      },
-    );
-  }
-
-  /**
-   * Changes the user's password by re-wrapping their master key
-   * @param userId - The ID of the user
-   * @param currentPassword - The current password
-   * @param newPassword - The new password
-   * @param session - The session to use for the query
-   * @returns void
-   */
-  public async changePassword(
-    userId: string,
-    currentPassword: string,
-    newPassword: string,
-    session?: ClientSession,
-  ): Promise<void> {
-    return await this.withTransaction<void>(
-      async (sess: ClientSession | undefined) => {
-        const UserModel = ModelRegistry.instance.getTypedModel<
-          IUserDocument<S, I>
-        >(BaseModelName.User);
-        const userDoc = await UserModel.findById(
-          this.idConverter(userId),
-        ).session(sess ?? null);
-        if (!userDoc || !userDoc.passwordWrappedPrivateKey) {
-          throw new UserNotFoundError();
-        }
-
-        if (!this.application.constants.PasswordRegex.test(newPassword)) {
-          throw new InvalidNewPasswordError();
-        }
-
-        const currentPasswordSecure = new SecureString(currentPassword);
-        const newPasswordSecure = new SecureString(newPassword);
-
-        try {
-          // Unwrap existing private key and rewrap under new password
-          const priv = this.keyWrappingService.unwrapSecret(
-            userDoc.passwordWrappedPrivateKey,
-            currentPasswordSecure,
-          );
-          try {
-            const wrapped = this.keyWrappingService.wrapSecret(
-              priv,
-              newPasswordSecure,
-              this.application.constants,
-            );
-            userDoc.passwordWrappedPrivateKey = wrapped;
-            await userDoc.save({ session: sess });
-          } finally {
-            priv.dispose();
-          }
-        } catch (error: unknown) {
-          // Re-throw original error so controller can map it properly
-          // Re-throw original error so controller can map it properly
-          throw error as Error;
-        } finally {
-          currentPasswordSecure.dispose();
-          newPasswordSecure.dispose();
-        }
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout * 5,
-      },
-    );
-  }
-
-  /**
-   * Retrieve an email token by its token string and type
-   * @param token - The token string
-   * @param type - The type of the email token
-   * @param session - The session to use for the query
-   * @returns The email token document or null if not found
-   */
-  public async findEmailToken(
-    token: string,
-    type?: EmailTokenType,
-    session?: ClientSession,
-  ): Promise<IEmailTokenDocument | null> {
-    const EmailTokenModel =
-      ModelRegistry.instance.getTypedModel<IEmailTokenDocument>(
-        BaseModelName.EmailToken,
-      );
-    return await EmailTokenModel.findOne({
-      token: token.toLowerCase().trim(),
-      ...(type ? { type } : {}),
-      expiresAt: { $gt: new Date() },
-    }).session(session ?? null);
-  }
-
-  /**
-   * Verify email token is valid
-   * @param token - The email token
-   * @param session - The session to use for the query
-   * @returns void
-   */
-  public async verifyEmailToken(
-    token: string,
-    type: EmailTokenType,
-    session?: ClientSession,
-  ): Promise<void> {
-    return await this.withTransaction<void>(
-      async (sess: ClientSession | undefined) => {
-        // Find and validate the token
-        const emailToken = await this.findEmailToken(token, type, sess);
-
-        if (!emailToken) {
-          throw new EmailTokenUsedOrInvalidError();
-        }
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout * 5,
-      },
-    );
-  }
-
-  /**
-   * Reset password using email token
-   * @param token - The email token
-   * @param newPassword - The new password
-   * @param session - The session to use for the query
-   * @returns void
-   */
-  public async resetPasswordWithToken(
-    token: string,
-    newPassword: string,
-    credential?: string, // either mnemonic or current password; required
-    session?: ClientSession,
-  ): Promise<void> {
-    if (!this.application.constants.PasswordRegex.test(newPassword)) {
-      throw new InvalidNewPasswordError();
-    }
-    if (!credential) {
-      throw new EmailTokenUsedOrInvalidError();
-    }
-
-    return await this.withTransaction<void>(
-      async (sess: ClientSession | undefined) => {
-        const EmailTokenModel =
-          ModelRegistry.instance.getTypedModel<IEmailTokenDocument>(
-            BaseModelName.EmailToken,
-          );
-        const UserModel = ModelRegistry.instance.getTypedModel<
-          IUserDocument<S, I>
-        >(BaseModelName.User);
-
-        // Find and validate the token
-        const emailToken = await this.findEmailToken(
-          token,
-          EmailTokenType.PasswordReset,
-          sess,
-        );
-
-        if (!emailToken) {
-          throw new EmailTokenUsedOrInvalidError();
-        }
-
-        // Find the user
-        const userDoc = await UserModel.findById(emailToken.userId).session(
-          sess ?? null,
-        );
-        if (!userDoc) {
-          throw new UserNotFoundError();
-        }
-        // Update password-wrapped secrets based on credential type (Option B)
-        const newPasswordSecure = new SecureString(newPassword);
-        try {
-          if (this.application.constants.MnemonicRegex.test(credential)) {
-            // Credential is mnemonic: verify it belongs to this user via public key
-            const providedMnemonic = new SecureString(credential);
-            try {
-              const { wallet } =
-                this.eciesService.walletAndSeedFromMnemonic(providedMnemonic);
-              const pub = Buffer.concat([
-                Buffer.from([
-                  this.application.constants.ECIES.PUBLIC_KEY_MAGIC,
-                ]),
-                wallet.getPublicKey(),
-              ]);
-              if (pub.toString('hex') !== userDoc.publicKey) {
-                throw new InvalidCredentialsError();
-              }
-
-              // Derive private key from mnemonic and wrap it with new password
-              const privateKey = wallet.getPrivateKey();
-              const priv = new SecureBuffer(privateKey);
-              try {
-                const wrappedPriv = this.keyWrappingService.wrapSecret(
-                  priv,
-                  newPasswordSecure,
-                  this.application.constants,
-                );
-                userDoc.passwordWrappedPrivateKey = wrappedPriv;
-                await userDoc.save({ session: sess });
-              } finally {
-                priv.dispose();
-              }
-            } finally {
-              providedMnemonic.dispose();
-            }
-          } else {
-            // Credential is current password: unwrap existing master key
-            if (!userDoc.passwordWrappedPrivateKey) {
-              throw new InvalidCredentialsError();
-            }
-            const privateKeyBuf =
-              await this.keyWrappingService.unwrapSecretAsync(
-                userDoc.passwordWrappedPrivateKey!,
-                credential,
-                this.application.constants,
-              );
-            try {
-              // Re-wrap the existing private key under the new password
-              const wrappedPriv = this.keyWrappingService.wrapSecret(
-                privateKeyBuf,
-                newPasswordSecure,
-                this.application.constants,
-              );
-              userDoc.passwordWrappedPrivateKey = wrappedPriv;
-              await userDoc.save({ session: sess });
-            } finally {
-              privateKeyBuf.dispose();
-            }
-          }
-
-          // Delete the used token
-          await EmailTokenModel.deleteOne({ _id: emailToken._id }).session(
-            sess ?? null,
-          );
-
-          // Dispose temporary master key
-        } finally {
-          newPasswordSecure.dispose();
-        }
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout * 5,
-      },
-    );
-  }
-
-  /**
-   * Generate a login challenge for the client to sign
-   * @returns The login challenge in hex
-   */
-  public generateDirectLoginChallenge(): string {
-    const adminMember = SystemUserService.getSystemUser(
-      this.application.environment,
-      this.application.constants,
-    );
-    const time = Buffer.alloc(8);
-    time.writeBigUInt64BE(BigInt(new Date().getTime()));
-    const nonce = randomBytes(32);
-    const signature = adminMember.sign(Buffer.concat([time, nonce]));
-    return Buffer.concat([time, nonce, signature]).toString('hex');
-  }
-
-  /**
-   * Verifies a direct login challenge response
-   * @param serverSignedRequest The login challenge response in hex
-   * @param session The mongoose session, if provided
-   * @returns A promise with the user document and user member object
-   */
-  public async verifyDirectLoginChallenge(
-    serverSignedRequest: string,
-    signature: string,
-    username?: string,
-    email?: string,
-    session?: ClientSession,
-  ): Promise<{ userDoc: IUserDocument<S, I>; userMember: BackendMember }> {
-    return await this.withTransaction<{
-      userDoc: IUserDocument<S, I>;
-      userMember: BackendMember;
-    }>(
-      async (sess: ClientSession | undefined) => {
-        // serverSignedRequest is:
-        // time (8) +
-        // nonce (32) +
-        // server signature (64) +
-        // signature (64)
-        if (
-          serverSignedRequest.length <
-          (8 + 32 + this.application.constants.ECIES.SIGNATURE_SIZE) * 2
-        ) {
-          throw new InvalidChallengeResponseError();
-        }
-        // get signed request into a buffer
-        const requestBuffer = Buffer.from(serverSignedRequest, 'hex');
-        // start tracking offset
-        let offset = 0;
-        // get the time
-        const time = requestBuffer.subarray(offset, 8);
-        offset += 8;
-        // get the nonce
-        const nonce = requestBuffer.subarray(offset, 40);
-        offset += 32;
-        // get the server signature
-        const serverSignature = requestBuffer.subarray(
-          offset,
-          this.application.constants.ECIES.SIGNATURE_SIZE + 40,
-        );
-        offset += this.application.constants.ECIES.SIGNATURE_SIZE;
-        const signedDataLength = offset;
-        if (offset !== requestBuffer.length) {
-          throw new InvalidChallengeResponseError();
-        }
-        // validate time is within acceptable range
-        const timeMs = time.readBigUInt64BE();
-        if (
-          new Date().getTime() - Number(timeMs) >
-          this.application.constants.LoginChallengeExpiration
-        ) {
-          throw new LoginChallengeExpiredError();
-        }
-        // validate the server's signature on the time + nonce portion
-        const adminMember = SystemUserService.getSystemUser(
-          this.application.environment,
-          this.application.constants,
-        );
-        if (
-          !adminMember.verify(
-            serverSignature as SignatureBuffer,
-            Buffer.concat([time, nonce]),
-          )
-        ) {
-          throw new InvalidChallengeResponseError();
-        }
-        // locate the user by email or username
-        const userDoc = await this.findUser(email, username, sess);
-        if (!userDoc) {
-          throw new InvalidChallengeResponseError();
-        }
-        // get the user's member object
-        const user = await this.makeUserFromUserDoc(
-          userDoc,
-          undefined,
-          undefined,
-          undefined,
-          undefined,
-          sess,
-        );
-        // get the signed portion of the response
-        const signedData = requestBuffer.subarray(0, signedDataLength);
-        // verify the user's signature on the signed portion
-        if (
-          !user.verify(
-            Buffer.from(signature, 'hex') as SignatureBuffer,
-            signedData,
-          )
-        ) {
-          throw new InvalidChallengeResponseError();
-        }
-
-        if (userDoc.directChallenge !== true) {
-          throw new DirectChallengeNotEnabledError();
-        }
-
-        // if the user is valid, try to use the token (prevents replay attacks)
-        await DirectLoginTokenService.useToken(
-          this.application,
-          userDoc._id,
-          nonce.toString('hex'),
-        );
-
-        // if successful, update lastLogin
-        await this.updateLastLogin(userDoc._id);
-
-        // return the user document and member object
-        return { userDoc, userMember: user };
-      },
-      session,
-      { timeoutMs: this.application.environment.mongo.transactionTimeout },
-    );
-  }
-
-  /**
-   * Request a login link via email
-   * @param email Email address
-   * @param username Username
-   * @param session Existing session, if any
-   * @returns void
-   */
-  public async requestEmailLogin(
-    email?: string,
-    username?: string,
-    session?: ClientSession,
-  ): Promise<void> {
-    return this.withTransaction<void>(
-      async (sess: ClientSession | undefined) => {
-        const userDoc = await this.findUser(email, username, sess);
-        if (!userDoc) {
-          return;
-        }
-        await this.createAndSendEmailToken(
-          userDoc,
-          EmailTokenType.LoginRequest,
-          sess,
-          this.application.environment.debug,
-        );
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout,
-      },
-    );
-  }
-
-  /**
-   * Validate an email login token challenge
-   * @param token The token to challenge
-   * @param signature The signature of the token by the user's private key
-   * @param session The session to use for the query
-   * @returns The user document if the challenge is valid
-   */
-  public async validateEmailLoginTokenChallenge(
-    token: string,
-    signature: string,
-    session?: ClientSession,
-  ): Promise<IUserDocument<S, I>> {
-    return this.withTransaction<IUserDocument<S, I>>(
-      async (sess: ClientSession | undefined) => {
-        const emailToken = await this.findEmailToken(
-          token,
-          EmailTokenType.LoginRequest,
-          sess,
-        );
-        if (!emailToken) {
-          throw new EmailTokenUsedOrInvalidError();
-        }
-        const userDoc = await this.findUser(emailToken.email, undefined, sess);
-        if (!userDoc) {
-          throw new UserNotFoundError();
-        }
-        const user = await this.makeUserFromUserDoc(
-          userDoc,
-          undefined,
-          undefined,
-          undefined,
-          undefined,
-          sess,
-        );
-        const result = user.verify(
-          Buffer.from(signature, 'hex') as SignatureBuffer,
-          Buffer.from(token, 'hex'),
-        );
-        if (!result) {
-          throw new InvalidChallengeResponseError();
-        }
-        await emailToken.deleteOne({ session: sess ?? null });
-        await this.updateLastLogin(userDoc._id);
-        return userDoc;
-      },
-      session,
-      {
-        timeoutMs: this.application.environment.mongo.transactionTimeout,
-      },
-    );
-  }
-
-  /**
-   * Updates the user's last login time atomically
-   * @param userId - The ID of the user
-   * @returns void
-   */
-  public async updateLastLogin(userId: I): Promise<void> {
-    const UserModel = ModelRegistry.instance.get('User')?.model;
-    try {
-      // Check if the database connection is still open
-      const connection = this.application.db.connection;
-      if (connection.readyState !== 1) {
-        // Connection is not open (0 = disconnected, 1 = connected, 2 = connecting, 3 = disconnecting)
-        return; // Silently return if connection is not available
-      }
-
-      // Use atomic update to avoid conflicts and ensure we only update lastLogin
-      // Use a separate session to avoid interfering with any ongoing transactions
-      await UserModel.updateOne(
-        { _id: userId },
-        {
-          $set: { lastLogin: new Date() },
-          $setOnInsert: {}, // Prevent any unintended document creation
-        },
-        {
-          upsert: false, // Never create a new document
-          runValidators: false, // Skip validation for performance since we're only updating lastLogin
-          // Don't use any session to avoid transaction conflicts
-        },
-      );
-    } catch (error) {
-      // Check if the error is due to client being closed
-      if (
-        error instanceof Error &&
-        (error.message.includes('client was closed') ||
-          error.message.includes('MongoClientClosedError') ||
-          error.name === 'MongoClientClosedError')
-      ) {
-        // This is expected during shutdown, don't log it as an error
-        return;
-      }
-
-      // If this fails, it's not critical for login functionality. Ignore and move on.
-    }
-  }
-}