apiKey.ts

import { Model, Document, Types } from 'mongoose';
import { VirtualId, MongooseTimestamps } from './mongoose';
import { Error, RouteParam } from './express';

// -------- MONGOOSE --------
/** Full Api Key interface */
export interface IApiKey extends VirtualId, MongooseTimestamps {
  _id: Types.ObjectId;
  __v: number;
  label: string;
  lastUsedAt?: Date;
  hashedKey: string;
  token?: string;
}

/** Mongoose document object for API Key */
export interface ApiKeyDocument
  extends IApiKey,
    Omit<Document<Types.ObjectId>, 'id'> {
  toJSON(options?: any): IApiKey;
  toObject(options?: any): IApiKey;
}

/**
 * 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' | 'token'
  > {}

/** Mongoose model for API Key */
export interface ApiKeyModel extends Model<ApiKeyDocument> {}

// -------- API --------
/**
 * Response body for userController.createApiKey & userController.removeApiKey
 *   - Either an ApiKeyResponse or Error
 */
export type ApiKeyResponseOrError = ApiKeyResponse | Error;

/** Response for api-key related endpoints, containing list of keys */
export interface ApiKeyResponse {
  apiKeys: ApiKeyDocument[];
}

/** userController.createApiKey - Request */
export interface CreateApiKeyRequestBody {
  label: string;
}

/** userController.removeApiKey - Request */
export interface RemoveApiKeyRequestParams extends RouteParam {
  keyId: string;
}