mongoose-softdelete-typescript/lib/index.js

Mongoose soft deletion plugin for typescript, support transaction

"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (_) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.softDeletePlugin = void 0;
var softDeletePlugin = function (schema) {
    schema.add({
        isDeleted: {
            type: Boolean,
            required: true,
            default: false,
        },
        deletedAt: {
            type: Date,
            default: null,
        },
    });
    schema.pre('save', function (next) {
        if (!this.isDeleted) {
            this.isDeleted = false;
        }
        if (!this.deletedAt) {
            this.deletedAt = null;
        }
        next();
    });
    schema.statics.softDelete = function (conditions, session) {
        var updateQuery = this.updateMany(conditions, {
            isDeleted: true,
            deletedAt: new Date(),
        });
        if (session) {
            updateQuery.session(session);
        }
        return updateQuery;
    };
    schema.statics.restore = function (conditions, session) {
        var restoreQuery = this.updateMany(conditions, {
            isDeleted: false,
            deletedAt: null,
        });
        if (session) {
            restoreQuery.session(session);
        }
        return restoreQuery;
    };
    // @ts-ignore
    schema.methods.softDelete = function (session) {
        this.isDeleted = true;
        this.deletedAt = new Date();
        if (session) {
            return this.save({ session: session });
        }
        return this.save();
    };
    // @ts-ignore
    schema.methods.restore = function (session) {
        this.isDeleted = false;
        this.deletedAt = null;
        if (session) {
            return this.save({ session: session });
        }
        return this.save();
    };
    schema.statics.findDeleted = function (cond) {
        if (typeof cond === 'undefined') {
            cond = true;
        }
        return this.where({
            isDeleted: cond,
        });
    };
    var typesFindQueryMiddleware = [
        'count',
        'countDocuments',
        'find',
        'findOne',
        'findOneAndDelete',
        'findOneAndRemove',
        'findOneAndUpdate',
        'update',
        'updateOne',
        'updateMany',
    ];
    var excludeInFindQueriesIsDeleted = function (next) {
        return __awaiter(this, void 0, void 0, function () {
            var filters;
            return __generator(this, function (_a) {
                filters = this.getFilter();
                if (!filters.hasOwnProperty('isDeleted')) {
                    this.where({ isDeleted: false });
                }
                next();
                return [2 /*return*/];
            });
        });
    };
    typesFindQueryMiddleware.forEach(function (type) {
        // @ts-ignore
        schema.pre(type, excludeInFindQueriesIsDeleted);
    });
};
exports.softDeletePlugin = softDeletePlugin;