mongoose-smart-delete/tests/deleted.test.js

A Mongoose plugin for implementing soft delete functionality, allowing documents to be marked as deleted without being removed from the database.

const createModel = require('./setup/createModel')
const modes       = require('./setup/modes')

modes.forEach((mode) => {
  describe('SoftDelete - deleted field', () => {

    let Model

    afterEach(async () => {
      await Model.deleteMany({}, {softDelete: false, withDeleted: true})
    })

    it('Deleted document should have deleted field set to true when config.deleted.field is not provided', async () => {
      Model          = createModel({}, {mode: mode})
      const Document = await Model.create({})
      await Document.deleteOne()
      const Deleted = await Model.findOne({_id: Document._id}).withDeleted()
      expect(Deleted.deleted).toBe(true)
      expect(Deleted.deletedAt).toBeUndefined()
      expect(Deleted.deletedBy).toBeUndefined()
    })

    it('Deleted document should have custom deleted field set to true when config.deleted.field is provided', async () => {

      const deletedField = 'isDeleted'

      Model          = createModel({}, {
        deleted: {
          field: deletedField
        },
        mode:    mode
      })
      const Document = await Model.create({})
      await Document.deleteOne()
      const Deleted = await Model.findOne({_id: Document._id}).withDeleted()
      expect(Deleted.deleted).toBeUndefined()
      expect(Deleted[deletedField]).toBe(true)
    })
  })
})