models/apiKey: re-implement in pattern from attempt 2 --no-verify

Author: clairep94

server/models/apiKey.ts

@@ -1,7 +1,7 @@
-import { Schema, InferSchemaType } from 'mongoose';
-import { SanitisedApiKey } from '../types/apiKey';
+import { Schema } from 'mongoose';
+import { SanitisedApiKey, ApiKeyDocument, ApiKeyModel } from '../types/apiKey';
 
-export const apiKeySchema = new Schema(
+export const apiKeySchema = new Schema<ApiKeyDocument, ApiKeyModel>(
   {
     label: { type: String, default: 'API Key' },
     lastUsedAt: { type: Date },
@@ -14,18 +14,12 @@ apiKeySchema.virtual('id').get(function getApiKeyId() {
   return this._id.toHexString();
 });
 
-export interface ApiKeyVirtuals {
-  id: string;
-}
-
-export type ApiKeySchemaType = InferSchemaType<typeof apiKeySchema>;
-
 /**
  * When serialising an APIKey instance, the `hashedKey` field
  * should never be exposed to the client. So we only return
  * a safe list of fields when toObject and toJSON are called.
  */
-function apiKeyMetadata(doc: any, _ret: any, _options: any): SanitisedApiKey {
+function apiKeyMetadata(doc: ApiKeyDocument): SanitisedApiKey {
   return {
     id: doc.id,
     label: doc.label,

server/types/apiKey.ts

@@ -1,18 +1,26 @@
-import { Model, model, Document } from 'mongoose';
-import {
-  ApiKeySchemaType,
-  apiKeySchema,
-  ApiKeyVirtuals
-} from '../models/apiKey';
+import { Model, Document, Types } from 'mongoose';
+import { VirtualId, MongooseTimestamps } from './mongoose';
 
-export type ApiKeyDocument = Document & ApiKeySchemaType & ApiKeyVirtuals;
+export interface IApiKey extends VirtualId, MongooseTimestamps {
+  label: string;
+  lastUsedAt?: Date;
+  hashedKey: string;
+}
 
-export type ApiKeyModel = Model<ApiKeyDocument>;
-
-export const ApiKey = model<ApiKeyDocument, ApiKeyModel>(
-  'ApiKey',
-  apiKeySchema
-);
+/** Mongoose document object for API Key */
+export interface ApiKeyDocument
+  extends IApiKey,
+    Omit<Document<Types.ObjectId>, 'id'> {
+  toJSON(options?: any): SanitisedApiKey;
+  toObject(options?: any): SanitisedApiKey;
+}
 
+/**
+ * Sanitised API key object which hides the `hashedKey` field
+ * and can be exposed to the client
+ */
 export interface SanitisedApiKey
   extends Pick<ApiKeyDocument, 'id' | 'label' | 'lastUsedAt' | 'createdAt'> {}
+
+/** Mongoose model for API Key */
+export interface ApiKeyModel extends Model<ApiKeyDocument> {}

server/types/mongoose.ts

@@ -0,0 +1,8 @@
+export type VirtualId = {
+  id: string;
+};
+
+export type MongooseTimestamps = {
+  createdAt: Date;
+  updatedAt?: Date;
+};