cleanup

Author: clairep94

server/models/user.ts

@@ -4,7 +4,8 @@ import {
   UserDocument,
   UserModel,
   CookieConsentOptions,
-  EmailConfirmationStates
+  EmailConfirmationStates,
+  ApiKeyDocument
 } from '../types';
 import { apiKeySchema } from './apiKey';
 
@@ -147,7 +148,7 @@ userSchema.set('toJSON', {
  */
 userSchema.methods.comparePassword = async function comparePassword(
   candidatePassword: string
-) {
+): Promise<boolean> {
   if (!this.password) {
     return false;
   }
@@ -165,7 +166,7 @@ userSchema.methods.comparePassword = async function comparePassword(
  */
 userSchema.methods.findMatchingKey = async function findMatchingKey(
   candidateKey: string
-) {
+): Promise<{ isMatch: boolean; keyDocument: ApiKeyDocument | null }> {
   let keyObj = { isMatch: false, keyDocument: null };
   /* eslint-disable no-restricted-syntax */
   for (const k of this.apiKeys) {
@@ -194,7 +195,9 @@ userSchema.methods.findMatchingKey = async function findMatchingKey(
  * @callback [cb] - Optional error-first callback that passes User document
  * @return {Object} - Returns User Object fulfilled by User document
  */
-userSchema.statics.findByEmail = async function findByEmail(email) {
+userSchema.statics.findByEmail = async function findByEmail(
+  email: string | string[]
+): Promise<UserDocument | null> {
   const user = this;
   const query = Array.isArray(email) ? { email: { $in: email } } : { email };
 
@@ -212,9 +215,11 @@ userSchema.statics.findByEmail = async function findByEmail(email) {
  * Queries User collection by emails and returns all Users that match.
  *
  * @param {string[]} emails - Array of email strings
- * @return {Promise<Object>} - Returns Promise fulfilled by User document
+ * @return {Promise<UserDocument[]>} - Returns Promise fulfilled by User document
  */
-userSchema.statics.findAllByEmails = async function findAllByEmails(emails) {
+userSchema.statics.findAllByEmails = async function findAllByEmails(
+  emails: string[]
+): Promise<UserDocument[] | null> {
   const user = this;
   const query = {
     email: { $in: emails }
@@ -235,22 +240,18 @@ userSchema.statics.findAllByEmails = async function findAllByEmails(emails) {
  * @param {string} username - Username string
  * @param {Object} [options] - Optional options
  * @param {boolean} options.caseInsensitive - Does a caseInsensitive query, defaults to false
- * @return {Object} - Returns User Object fulfilled by User document
+ * @return {UserDocument} - Returns User Object fulfilled by User document
  */
 userSchema.statics.findByUsername = async function findByUsername(
-  username,
-  options
-) {
+  username: string,
+  options?: { caseInsensitive?: boolean }
+): Promise<UserDocument | null> {
   const user = this;
   const query = {
     username
   };
 
-  if (
-    arguments.length === 2 &&
-    typeof options === 'object' &&
-    options.caseInsensitive
-  ) {
+  if (options?.caseInsensitive) {
     const foundUser = await user
       .findOne(query)
       .collation({ locale: 'en', strength: 2 })
@@ -274,17 +275,16 @@ userSchema.statics.findByUsername = async function findByUsername(
  *                                          default query for username or email, defaults
  *                                          to false
  * @param {("email"|"username")} options.valueType - Prevents automatic type inferrence
- * @return {Object} - Returns User Object fulfilled by User document
+ * @return {UserDocument} - Returns User Object fulfilled by User document
  */
 userSchema.statics.findByEmailOrUsername = async function findByEmailOrUsername(
-  value,
-  options
-) {
+  value: string,
+  options?: { caseInsensitive?: boolean; valueType?: 'email' | 'username' }
+): Promise<UserDocument | null> {
   const user = this;
-  const isEmail =
-    options && options.valueType
-      ? options.valueType === 'email'
-      : value.indexOf('@') > -1;
+  const isEmail = options?.valueType
+    ? options.valueType === 'email'
+    : value.indexOf('@') > -1;
 
   // do the case insensitive stuff
   if (
@@ -316,12 +316,12 @@ userSchema.statics.findByEmailOrUsername = async function findByEmailOrUsername(
  *
  * @param {string} email
  * @param {string} username
- * @return {Object} - Returns User Object fulfilled by User document
+ * @return {UserDocument} - Returns User Object fulfilled by User document
  */
 userSchema.statics.findByEmailAndUsername = async function findByEmailAndUsername(
-  email,
-  username
-) {
+  email: string,
+  username: string
+): Promise<UserDocument | null> {
   const user = this;
   const query = {
     $or: [{ email }, { username }]

server/types/user.ts

@@ -1,11 +1,11 @@
 import { Document, Model, Types } from 'mongoose';
+import { VirtualId, MongooseTimestamps } from './mongoose';
 import { UserPreferences, CookieConsentOptions } from './userPreferences';
 import { EmailConfirmationStates } from './email';
 import { ApiKeyDocument } from './apiKey';
 
 /** Full User interface */
-export interface IUser {
-  id: string;
+export interface IUser extends VirtualId, MongooseTimestamps {
   name: string;
   username: string;
   password: string;
@@ -52,7 +52,7 @@ export interface UserDocument
   comparePassword(candidatePassword: string): Promise<boolean>;
   findMatchingKey(
     candidateKey: string
-  ): Promise<{ isMatch: boolean; keyDocument: UserDocument | null }>;
+  ): Promise<{ isMatch: boolean; keyDocument: ApiKeyDocument | null }>;
 }
 
 /** Mongoose model for User */