apiKey: first attempt at defining types --no-verify

Author: clairep94

server/models/apiKey.ts

@@ -1,6 +1,34 @@
-import { Schema } from 'mongoose';
+import mongoose, { Schema, Model, InferSchemaType } from 'mongoose';
 
-export const apiKeySchema = new Schema(
+interface IApiKey {
+  label: string;
+  lastUsedAt: Date;
+  hashedKey: string;
+}
+
+interface ApiKeyVirtuals {
+  id: string;
+}
+
+type ApiKeyModelType = Model<IApiKey, {}, {}, ApiKeyVirtuals>;
+
+interface MongooseTimestamps {
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+interface SanitisedApiKey
+  extends Omit<IApiKey, 'hashedKey'>,
+    ApiKeyVirtuals,
+    Pick<MongooseTimestamps, 'createdAt'> {}
+
+export const apiKeySchema = new Schema<
+  IApiKey,
+  ApiKeyModelType,
+  {},
+  {},
+  ApiKeyVirtuals
+>(
   {
     label: { type: String, default: 'API Key' },
     lastUsedAt: { type: Date },
@@ -18,7 +46,7 @@ apiKeySchema.virtual('id').get(function getApiKeyId() {
  * 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, ret, options) {
+function apiKeyMetadata(doc, ret, options): SanitisedApiKey {
   return {
     id: doc.id,
     label: doc.label,
@@ -35,3 +63,9 @@ apiKeySchema.set('toJSON', {
   virtuals: true,
   transform: apiKeyMetadata
 });
+
+// Derived type for schema fields (including timestamps)
+type ApiKeySchemaType = InferSchemaType<typeof apiKeySchema>;
+
+// The actual document type
+// export type ApiKeyDocument = Document & ApiKeySchemaFields & ApiKeyVirtuals;