Mongoose soft delete plugin
npm install mongoose-delete-tsMongoose Delete TS Plugin
=========
mongoose-delete-ts is simple and lightweight plugin that enables soft deletion of documents in MongoDB. This code is based on plugin mongoose-delete. But completely re-written in TypeScript and using mongoose query helpers.
npm install mongoose-delete-ts
Before you get started
This plugin uses for improved query performance. If you are adding this plugin to an existing project, make sure to manually update all existing documents with deleted=falseUsage
We can use this plugin with or without options.
$3
typescript
import mongooseDelete, { Deleted, DeletedQueryHelpers, DeletedMethods, DeletedStaticMethods } from 'mongoose-delete-ts';type Pet = { name: string } & Deleted;
type PetQueryHelpers = DeletedQueryHelpers;
type PetStaticMethods = DeletedStaticMethods;
type PetModel = Model & PetStaticMethods;
const petSchema = new Schema({
name: String
});
petSchema.plugin(mongooseDelete);
const PetPetModel = mongoose.model('Pet', petSchema);
const fluffy = new PetModel({ name: 'Fluffy' });
await fluffy.save();
// mongodb: { name: 'Fluffy', deleted: false }
await fluffy.delete();
// mongodb: { name: 'Fluffy', deleted: true }
await fluffy.restore();
// mongodb: { name: 'Fluffy', deleted: false }
const examplePetId = mongoose.Types.ObjectId("53da93b16b4a6670076b16bf");
const petDocument = await PetModel.deleteById(examplePetId);
// mongodb: { _id: '53da93b1...', name: 'Fluffy', deleted: true }
`
$3
typescript
import mongooseDelete, { Deleted, DeletedAt DeletedQueryHelpers, DeletedMethods, DeletedStaticMethods } from 'mongoose-delete-ts';type Pet = { name: string } & Deleted & DeletedAt;
type PetQueryHelpers = DeletedQueryHelpers;
type PetStaticMethods = DeletedStaticMethods;
type PetModel = Model & PetStaticMethods;
const petSchema = new Schema({
name: String
});
petSchema.plugin(mongooseDelete, { deletedAt: true });
const PetModel = mongoose.model('Pet', petSchema);
const fluffy = new PetModel({ name: 'Fluffy' });
await fluffy.save();
// mongodb: { name: 'Fluffy', deleted: false }
await fluffy.delete();
// mongodb: { name: 'Fluffy', deleted: true, deletedAt: ISODate("2014-08-01T10:34:53.171Z")}
await fluffy.restore();
// mongodb: { name: 'Fluffy', deleted: false }
`$3
typescript
import mongooseDelete, { Deleted, DeletedBy DeletedQueryHelpers, DeletedMethods, DeletedStaticMethods } from 'mongoose-delete-ts';type Pet = { name: string } & Deleted & DeletedBy;
type PetQueryHelpers = DeletedQueryHelpers;
type PetStaticMethods = DeletedStaticMethods & DeletedByStaticMethods
type PetModel = Model> & PetStaticMethods;
const petSchema = new Schema({
name: String
});
petSchema.plugin(mongooseDelete, { deletedBy: true });
const PetModel = mongoose.model('Pet', petSchema);
const fluffy = new PetModel({ name: 'Fluffy' });
await fluffy.save();
// mongodb: { name: 'Fluffy', deleted: false }
const idUser = mongoose.Types.ObjectId("53da93b16b4a6670076b16bf");
await fluffy.deleteByUser(idUser);
// mongodb: { name: 'Fluffy', deleted: true, deletedBy: ObjectId("53da93b16b4a6670076b16bf")}
await fluffy.restore();
// mongodb: { name: 'Fluffy', deleted: false }
`The type for
does not have to be ObjectId, you can set a custom type, such as String.`typescript
import mongooseDelete, { Deleted, DeletedBy DeletedQueryHelpers, DeletedMethods, DeletedStaticMethods } from 'mongoose-delete-ts';type Pet = { name: string } & Deleted & DeletedBy;
type PetQueryHelpers = DeletedQueryHelpers;
type PetStaticMethods = DeletedStaticMethods & DeletedByStaticMethods
type PetModel = Model> & PetStaticMethods;
const petSchema = new Schema({
name: String
});
petSchema.plugin(mongooseDelete, { deletedBy: { type: String } });
const PetModel = mongoose.model('Pet', petSchema);
const fluffy = new PetModel({ name: 'Fluffy' });
await fluffy.save();
// mongodb: { deleted: false, name: 'Fluffy' }
const userName = 'John Doe';
await fluffy.deleteByUser(userName)
// mongodb: { name: 'Fluffy', deleted: true, deletedBy: 'John Doe' }
await fluffy.restore()
`TypeScript support
$3
| Type | Adds property
| --- | ---
| | document.deleted
| | document.deletedAt
| | document.deletedBy$3
| Type | Adds method
| --- | ---
| | document.delete(), document.restore()
| | document.deleteByUser(user: TUser)$3
| Type | Adds static methods
| --- | ---
| | Model.restoreOne(...), Model.restoreMany(...)
| | Model.deleteOneByUser(user: TUser, ...), Model.deleteManyByUser(user: TUser, ...)$3
| Type | Adds query helpers
| --- | ---
| | allDocuments(), deletedDocuments()$3
typescript
// Delete multiple object
PetModel.deleteMany({});
PetModel.deleteMany({ age:10 });
PetModel.deleteManyByUser(idUser, {});
PetModel.deleteManyByUser(idUser, { age: 10 });// Restore multiple object
PetModel.restoreMany({});
PetModel.restoreMany({ age: 10 });
`$3
By default, all standard methods will exclude deleted documents from results, documents that have
. To override this behavior use allDocuments() or deletedDocuments() query helper functions or simply specify the deleted attribute manually.| only non deleted documents | only deleted documents | all documents |
|----------------------------|-------------------------|-----------------------------|
| countDocuments() | countDocuments().deletedDocuments() | countDocuments().allDocuments() |
| find() | find().deletedDocuments() | find().allDocuments() |
| findById() | findById().deletedDocuments() | findById().allDocuments() |
| findOne() | findOne().deletedDocuments() | findOne().allDocuments() |
| findOneAndUpdate() | findOneAndUpdate().deletedDocuments() | findOneAndUpdate().allDocuments() |
| findByIdAndUpdate() | findByIdAndUpdate().deletedDocuments()| findByIdAndUpdate().allDocuments()|
| updateOne() | updateOne({ deleted: true }) | updateOne({ deleted: { $in: [true, false] } }) |
| updateMany() | updateMany({ deleted: true }) | updateMany({ deleted: { $in: [true, false] } }) |
| aggregate() | aggregate([{ $match: { deleted: true }}]) | aggregate([{ $match: { deleted: { $in: [true, false] } }}]) |
$3
`typescript
// Override all methods (default)
petSchema.plugin(mongooseDelete, { overrideMethods: true });// Overide only specific methods
petSchema.plugin(mongooseDelete, { overrideMethods: ['countDocuments', 'find', 'findOne'] });
`$3
typescript
// will return only NON DELETED documents
const documents = await PetModel.find();// will return only DELETED documents
const deletedDocuments = await PetModel.find().deletedDocuments();
// will return ALL documents
const allDocuments = await PetModel.find().allDocuments();
`$3
typescript
// By default, validateBeforeDelete is set to true
petSchema.plugin(mongooseDelete);
// the previous line is identical to next line
petSchema.plugin(mongooseDelete, { validateBeforeDelete: true });// To disable model validation on delete, set validateBeforeDelete option to false
petSchema.plugin(mongooseDelete, { validateBeforeDelete: false });
`This is based on existing Mongoose validateBeforeSave option
$3
typescript
// Index only specific fields (default)
petSchema.plugin(mongooseDelete, { indexFields: ['deleted'] });
// or
petSchema.plugin(mongooseDelete, { indexFields: ['deleted', 'deletedAt'] });// Index all field related to plugin (deleted, deletedAt, deletedBy)
petSchema.plugin(mongooseDelete, { indexFields: true });
`$3
typescript
type Pet = { name: string; deleted_by?: string; deleted_at?: Date };
type PetQueryHelpers = DeletedQueryHelpers;
type PetStaticMethods = DeletedStaticMethods & DeletedByStaticMethods
type PetModel = Model> & PetStaticMethods;const petSchema = new Schema({
name: String
});
// Add a custom name for each property, will create alias for the original name (deletedBy/deletedAt)
petSchema.plugin(mongooseDelete, { deletedBy: 'deleted_by', deletedAt: 'deleted_at' });
// Use custom schema type definition by supplying an object
petSchema.plugin(mongooseDelete, { deletedBy: { name: 'deleted_by', type: String }, deletedAt: { name: 'deleted_at' } });
`
Expects a Mongoose Schema Types object with the added option of The MIT License
Copyright (c) 2021 Emil Janitzek https://pixel2.se/
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.