ts-patch-mongoose/src/model.ts

Patch history & events for mongoose models

import { model, Schema } from 'mongoose'

import type { History } from './types'

export const HistorySchema = new Schema<History>(
  {
    op: {
      type: String,
      required: true,
    },
    modelName: {
      type: String,
      required: true,
    },
    collectionName: {
      type: String,
      required: true,
    },
    collectionId: {
      type: Schema.Types.ObjectId,
      required: true,
    },
    doc: {
      type: Object,
    },
    patch: {
      type: Array,
    },
    user: {
      type: Object,
    },
    reason: {
      type: String,
    },
    metadata: {
      type: Object,
    },
    version: {
      type: Number,
      min: 0,
      default: 0,
    },
  },
  { timestamps: true },
)

HistorySchema.index({ collectionId: 1, version: -1 })
HistorySchema.index({ op: 1, modelName: 1, collectionName: 1, collectionId: 1, reason: 1, version: 1 })

export const HistoryModel = model<History>('History', HistorySchema, 'history')