models/user: resolve types using definitions from attempt 1 PR with tests passing

Author: clairep94

server/models/__test__/user.test.ts

@@ -86,7 +86,7 @@ describe('User model', () => {
 
     const found = await User.findByEmail('dave@example.com');
     expect(found).not.toBeNull();
-    expect(found.username).toBe('dave');
+    expect(found!.username).toBe('dave'); // found exists otherwise the previous expect would fail
   });
 
   it('should find user by username (case insensitive)', async () => {
@@ -98,7 +98,7 @@ describe('User model', () => {
 
     const found = await User.findByUsername('eve', { caseInsensitive: true });
     expect(found).not.toBeNull();
-    expect(found.email).toBe('eve@example.com');
+    expect(found!.email).toBe('eve@example.com'); // found exists otherwise the previous expect would fail
   });
 
   it('should return null for wrong username/email', async () => {
@@ -115,7 +115,8 @@ describe('User model', () => {
     await user.save();
 
     const savedUser = await User.findOne({ email: 'frank@example.com' });
-    const keyObj = await savedUser.findMatchingKey('hashedApiKey');
+    expect(savedUser).not.toBeNull();
+    const keyObj = await savedUser!.findMatchingKey('hashedApiKey'); // savedUser exists otherwise the previous expect would fail
 
     expect(keyObj.isMatch).toBe(true);
     expect(keyObj.keyDocument).not.toBeNull();

server/models/apiKey.ts

@@ -1,5 +1,5 @@
 import { Schema } from 'mongoose';
-import { SanitisedApiKey, ApiKeyDocument, ApiKeyModel } from '../types/apiKey';
+import { SanitisedApiKey, ApiKeyDocument, ApiKeyModel } from '../types';
 
 export const apiKeySchema = new Schema<ApiKeyDocument, ApiKeyModel>(
   {

server/models/user.ts

@@ -1,16 +1,20 @@
-import mongoose from 'mongoose';
+import mongoose, { Schema } from 'mongoose';
 import bcrypt from 'bcryptjs';
+import {
+  UserDocument,
+  UserModel,
+  CookieConsentOptions,
+  EmailConfirmationStates
+} from '../types';
 import { apiKeySchema } from './apiKey';
 
-const EmailConfirmationStates = {
-  Verified: 'verified',
-  Sent: 'sent',
-  Resent: 'resent'
-};
-
-const { Schema } = mongoose;
+// const EmailConfirmationStates = {
+//   Verified: 'verified',
+//   Sent: 'sent',
+//   Resent: 'resent'
+// };
 
-const userSchema = new Schema(
+const userSchema = new Schema<UserDocument, UserModel>(
   {
     name: { type: String, default: '' },
     username: { type: String, required: true, unique: true },
@@ -44,13 +48,13 @@ const userSchema = new Schema(
     totalSize: { type: Number, default: 0 },
     cookieConsent: {
       type: String,
-      enum: ['none', 'essential', 'all'],
-      default: 'none'
+      enum: Object.values(CookieConsentOptions),
+      default: CookieConsentOptions.NONE
     },
     banned: { type: Boolean, default: false },
     lastLoginTimestamp: { type: Date }
   },
-  { timestamps: true, usePushEach: true }
+  { timestamps: true }
 );
 
 /**
@@ -67,6 +71,10 @@ userSchema.pre('save', function checkPassword(next) {
       next(err);
       return;
     }
+    if (!user.password) {
+      next(new Error('Password is missing'));
+      return;
+    }
     bcrypt.hash(user.password, salt, (innerErr, hash) => {
       if (innerErr) {
         next(innerErr);
@@ -92,7 +100,7 @@ userSchema.pre('save', function checkApiKey(next) {
   let pendingTasks = 0;
   let nextCalled = false;
 
-  const done = (err) => {
+  const done = (err?: mongoose.CallbackError) => {
     if (nextCalled) return;
     if (err) {
       nextCalled = true;
@@ -144,7 +152,7 @@ userSchema.set('toJSON', {
  * @return {Promise<boolean>}
  */
 userSchema.methods.comparePassword = async function comparePassword(
-  candidatePassword
+  candidatePassword: string
 ) {
   if (!this.password) {
     return false;
@@ -162,7 +170,7 @@ userSchema.methods.comparePassword = async function comparePassword(
  * Helper method for validating a user's api key
  */
 userSchema.methods.findMatchingKey = async function findMatchingKey(
-  candidateKey
+  candidateKey: string
 ) {
   let keyObj = { isMatch: false, keyDocument: null };
   /* eslint-disable no-restricted-syntax */
@@ -332,9 +340,11 @@ userSchema.statics.findByEmailAndUsername = async function findByEmailAndUsernam
   return foundUser;
 };
 
-userSchema.statics.EmailConfirmation = EmailConfirmationStates;
+// userSchema.statics.EmailConfirmation = EmailConfirmationStates;
 
 userSchema.index({ username: 1 }, { collation: { locale: 'en', strength: 2 } });
 userSchema.index({ email: 1 }, { collation: { locale: 'en', strength: 2 } });
 
-export const User = mongoose.models.User || mongoose.model('User', userSchema);
+export const User =
+  (mongoose.models.User as UserModel) ||
+  mongoose.model<UserDocument, UserModel>('User', userSchema);

server/types/index.ts

@@ -1,2 +1,5 @@
+export * from './apiKey';
 export * from './email';
+export * from './mongoose';
+export * from './user';
 export * from './userPreferences';

server/types/user.ts

@@ -8,7 +8,7 @@ export interface IUser {
   id: string;
   name: string;
   username: string;
-  password?: string;
+  password: string;
   resetPasswordToken?: string;
   resetPasswordExpires?: number;
   verified?: string;