a mongoose plugin that allows you to soft delete documents and restore them in MongoDB (for JS & TS)
-
Soft delete your MongoDB documents and restore them
-
JS and TS
🏠 Homepage
npm install soft-delete-plugin-mongooseJavascript Version
const mongoose = require('mongoose'); const { softDeletePlugin } = require('soft-delete-plugin-mongoose'); const Schema = mongoose.Schema; const TestSchema = new Schema({ name: String, lastName: String }); TestSchema.plugin(softDeletePlugin); const TestModel = mongoose.model("Test", TestSchema); const test = new TestModel({name: 'hello', lastName: "world"}); /*** returns an object containing the number of softDeleted elements ***/ /*** {deleted: number} ***/ /*** the argument options is optional ***/ const options = { validateBeforeSave: false }; const deleted = await TestModel.softDelete({ _id: test._id, name: test.name }, options); /** const deleted = await Test.softDelete({ _id: test._id, name: test.name }); is also valid **/ /*** returns an object containing the number of restored elements ***/ /*** {restored: number} ***/ const restored = await TestModel.restore({ _id: test._id, name: test.name }); /*** returns all deleted elements ***/ const deletedElements = await TestModel.findDeleted(); /*** returns all available elements (not deleted) ***/ const availableElements = await TestModel.find(); /*** counts all available elements (not deleted) ***/ const countAvailable = await TestModel.count(); /*** findById returns the document whether deleted or not ***/Typescript Version
import * as mongoose from 'mongoose'; import { softDeletePlugin, SoftDeleteModel } from 'soft-delete-plugin-mongoose'; interface Test extends mongoose.Document { name: string; lastName: string; } const TestSchema = new mongoose.Schema({ name: String, lastName: String }); TestSchema.plugin(softDeletePlugin); // two different ways of implementing model depending on technology used // 1st way const testModel = mongoose.model<Test, SoftDeleteModel<Test>>('Test', TestSchema); //2nd way (nestjs way) constructor(@InjectModel('Test') private readonly testModel: SoftDeleteModel<Test>) {} const test = await new this.testModel({name: 'hello', lastName: 'world'}); /*** returns an object containing the number of softDeleted elements ***/ /*** {deleted: number} ***/ /*** the argument options is optional ***/ const options = { validateBeforeSave: false }; const deleted = await this.testModel.softDelete({ _id: test._id, name: test.name }, options); /** const deleted = await Test.softDelete({ _id: test._id, name: test.name }); is also valid **/ /*** returns an object containing the number of restored elements ***/ /*** {restored: number} ***/ const restored = await this.testModel.restore({ _id: test._id, name: test.name }); /*** returns all deleted elements ***/ const deletedElements = await this.testModel.findDeleted(); /*** returns all available elements (not deleted) ***/ const availableElements = await this.testModel.find(); /*** counts all available elements (not deleted) ***/ const countAvailable = await this.test.count(); /*** findById returns the document whether deleted or not ***/ /*** NEW in v2.0.0: Aggregation pipeline operations now automatically filter out soft-deleted documents ***/ const aggregationResults = await this.testModel.aggregate([ { $match: { name: 'hello' } }, // Soft-deleted documents are automatically excluded { $lookup: { from: 'other', localField: '_id', foreignField: 'testId', as: 'related' } } // Lookup also respects soft-delete ]); /*** NEW in v2.0.0: distinct() method now supports soft-delete filtering ***/ const distinctNames = await this.testModel.distinct('name'); // Returns only non-deleted documents /*** NEW in v2.0.0: findOneAndUpdate() method now supports soft-delete filtering ***/ const updated = await this.testModel.findOneAndUpdate( { name: 'hello' }, { lastName: 'updated' }, { new: true } ); // Will only find and update non-deleted documents- Enhanced aggregation pipeline support with automatic soft-delete filtering
- Improved query hooks for better performance and consistency
New Features:
- Aggregation Pipeline Support:
$matchand$lookupstages now automatically exclude soft-deleted documents - Enhanced Method Support: Added soft-delete aware hooks for:
distinct()- Returns only non-deleted documentsfindOneAndUpdate()- Only operates on non-deleted documents
- Improved Query Performance: Optimized query hooks for better database performance
Migration Guide: If you were previously working around soft-delete filtering in aggregation pipelines, you can now remove those manual filters as they're handled automatically.
👤 Nour
- Github: @nour-karoui
- LinkedIn: @nourkaroui
Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.
Give a STAR if this project helped you!
This README was generated with by readme-md-generator