mongoose-history-diff
Version:
A mongoose plugin to take diffs and history of your documents
227 lines (226 loc) • 10.1 kB
JavaScript
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
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 });
var mongoose_1 = require("mongoose");
var diff_1 = __importStar(require("./diff"));
function default_1(mongooseConnection, collectionName) {
if (!mongooseConnection)
throw new Error("'mongooseConnection' is required");
if (!collectionName)
throw new Error("'collectionName' is required");
var ItemSchema = new mongoose_1.Schema({
k: {
type: String,
enum: ['E', 'N', 'D', 'A'],
},
l: mongoose_1.Schema.Types.Mixed,
r: mongoose_1.Schema.Types.Mixed,
}, {
_id: false,
versionKey: false,
});
var ChangeSchema = new mongoose_1.Schema({
k: {
type: String,
enum: ['E', 'N', 'D', 'A'],
},
p: [String],
l: mongoose_1.Schema.Types.Mixed,
r: mongoose_1.Schema.Types.Mixed,
i: Number,
it: ItemSchema,
}, {
_id: false,
versionKey: false,
});
var DiffSchema = new mongoose_1.Schema({
dId: mongoose_1.Schema.Types.ObjectId,
c: [ChangeSchema],
v: Number,
}, {
versionKey: false,
timestamps: { createdAt: true, updatedAt: false },
collection: collectionName,
});
DiffSchema.index({ docId: 1, path: 1 });
DiffSchema.statics.createDiff = function (dId, v, changes) {
return __awaiter(this, void 0, void 0, function () {
var doc;
return __generator(this, function (_a) {
doc = new this({
dId: dId,
c: changes,
v: v,
});
return [2, doc.save()];
});
});
};
DiffSchema.statics.findByDocId = function (dId) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2, this.find({ dId: dId }).exec()];
});
});
};
DiffSchema.statics.findAfterVersion = function (dId, v) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2, this.find({ dId: dId, v: { $gte: v } })
.sort({ v: -1 })
.exec()];
});
});
};
DiffSchema.statics.findBeforeVersion = function (dId, v) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2, this.find({ dId: dId, v: { $lte: v } })
.sort({ v: -1 })
.exec()];
});
});
};
DiffSchema.statics.revertToVersion = function (d, v) {
return __awaiter(this, void 0, void 0, function () {
var doc, changes, diffDocs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
doc = typeof d.toObject === 'function' ? d.toObject() : d;
changes = [];
return [4, this.findAfterVersion(doc._id, v)];
case 1:
diffDocs = (_a.sent());
if (diffDocs.length === 0)
return [2, null];
diffDocs.forEach(function (diffDoc) { return changes.push.apply(changes, diffDoc.c); });
return [2, diff_1.revertChanges(doc, changes)];
}
});
});
};
DiffSchema.statics.mergeDiffs = function (doc, opts) {
return __awaiter(this, void 0, void 0, function () {
var _a, startVersion, endVersion, initialDoc, currentDoc;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
_a = opts || {}, startVersion = _a.startVersion, endVersion = _a.endVersion;
if (typeof startVersion === 'number' && startVersion < 1)
throw new Error("\"startVersion\" argument should be >= 1, but got: " + startVersion);
if (typeof endVersion === 'number' && endVersion < 1)
throw new Error("\"endVersion\" argument should be >= 1, but got: " + endVersion);
initialDoc = null;
currentDoc = __assign({}, doc.toObject());
if (!(startVersion && endVersion)) return [3, 3];
return [4, this.revertToVersion(currentDoc, startVersion)];
case 1:
initialDoc = _b.sent();
return [4, this.revertToVersion(currentDoc, endVersion)];
case 2:
currentDoc = _b.sent();
return [3, 10];
case 3:
if (!startVersion) return [3, 5];
return [4, this.revertToVersion(currentDoc, startVersion)];
case 4:
initialDoc = _b.sent();
return [3, 10];
case 5:
if (!endVersion) return [3, 8];
return [4, this.revertToVersion(currentDoc, 1)];
case 6:
initialDoc = _b.sent();
return [4, this.revertToVersion(currentDoc, endVersion)];
case 7:
currentDoc = _b.sent();
return [3, 10];
case 8: return [4, this.revertToVersion(currentDoc, 1)];
case 9:
initialDoc = _b.sent();
_b.label = 10;
case 10:
if (!initialDoc || !currentDoc)
return [2, []];
return [2, diff_1.default.findDiff(initialDoc, currentDoc)];
}
});
});
};
var modelName = collectionName + "_Model";
var Model;
if (mongooseConnection.modelNames().includes(modelName)) {
Model = mongooseConnection.models[modelName];
}
else {
Model = mongooseConnection.model(modelName, DiffSchema);
}
return Model;
}
exports.default = default_1;