@geekbears/gb-mongoose-keywords-plugin
Version:
A Mongoose plugin for keyword generation
207 lines • 10.1 kB
JavaScript
;
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 = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
return g.next = verb(0), g["throw"] = verb(1), g["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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
}
};
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.KeywordsMiddleware = void 0;
var lodash_1 = require("lodash");
var helpers_1 = require("./helpers");
var extraction_1 = require("./helpers/extraction");
/**
* Add keyword generation for a given schema
*
* @description
* Automatically generates keywords from the specified local and virtual paths and persists
* them into a new `__keywords` field.
*
* @usage
* Pass an object with the following options to configure the behavior of keyword generation.
*
* Available options are:
* - `paths`: a collection of the local schema paths to generate keywords from
* - `virtuals`: a map of virtual paths to be populated and generate keywords from
* - `omit`: a collection of words to be omitted from the resulting keywords
*
* @remarks
* Keywords will be generated automatically when creating a new document or updating an existing
* one via `findOneAndUpdate`
*/
var KeywordsMiddleware = function (schema, options) {
var _a = (0, helpers_1.validateOptions)(schema, options), paths = _a.paths, virtuals = _a.virtuals, omit = _a.omit;
/**
* Generate and extract keywords based on the preconfigured schema parameters
* @implementation
*/
schema.method('__generateKeywords', function () {
return __awaiter(this, void 0, void 0, function () {
var document_1, leanDoc_1, localKeywords, populatedKeywords, _a, keywords, err_1;
var _this = this;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
_b.trys.push([0, 2, , 3]);
document_1 = this;
leanDoc_1 = document_1.toObject({ virtuals: false, getters: false });
localKeywords = (0, lodash_1.flatten)(paths.map(function (path) { return (0, extraction_1.extractKeywordsFromField)(leanDoc_1[path], omit); }));
_a = lodash_1.flatten;
return [4 /*yield*/, Promise.all((0, lodash_1.keys)(virtuals).map(function (key) { return __awaiter(_this, void 0, void 0, function () {
var virtualPaths, populatedDoc;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
virtualPaths = virtuals[key];
return [4 /*yield*/, document_1.populate(key)];
case 1:
populatedDoc = (_a.sent()).toObject();
return [2 /*return*/, (0, lodash_1.flatten)(virtualPaths.map(function (path) { return (0, extraction_1.extractKeywordsFromPopulatedField)(populatedDoc[key], path, omit); }))];
}
});
}); }))];
case 1:
populatedKeywords = _a.apply(void 0, [_b.sent()]);
keywords = (0, lodash_1.uniq)(__spreadArray(__spreadArray([], localKeywords, true), populatedKeywords, true));
if (options.logging)
console.log("Generated keywords for ".concat(document_1.$model.name, ":").concat(document_1.id), keywords);
return [2 /*return*/, keywords];
case 2:
err_1 = _b.sent();
console.error("Error generating keywords");
console.error(err_1);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
});
});
/**
* Generate and save this documents keywords
* @implementation
*/
schema.method('__generateAndSaveKeywords', function () {
return __awaiter(this, void 0, void 0, function () {
var document, keywords;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
document = this;
return [4 /*yield*/, document.__generateKeywords()];
case 1:
keywords = _a.sent();
document.__keywords = __spreadArray([], keywords, true);
return [4 /*yield*/, document.save()];
case 2:
_a.sent();
return [2 /*return*/];
}
});
});
});
/**
* An array containing this document's generated keywords
* @remarks configure a text index on the field
* @implementation
*/
schema.add({
__keywords: {
type: [String],
index: 'text',
},
});
/**
* Pre-Save document hook
* Generate keywords when a new document is created for this collection
* @remarks requires `onNew` option enabled
*/
schema.pre('save', function () {
return __awaiter(this, void 0, void 0, function () {
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (!options.onNew)
return [2 /*return*/];
if (!this.isNew)
return [2 /*return*/];
_a = this;
return [4 /*yield*/, this.__generateKeywords()];
case 1:
_a.__keywords = _b.sent();
return [2 /*return*/];
}
});
});
});
/**
* Pre-Update query hook
* Generate keywords when a document in this collection updated
* @remarks requires `onUpdate` option enabled
*/
schema.pre('findOneAndUpdate', { query: true, document: false }, function () {
return __awaiter(this, void 0, void 0, function () {
var document, _a;
var _b;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
if (!options.onUpdate)
return [2 /*return*/];
return [4 /*yield*/, this.model.findOne(this.getQuery())];
case 1:
document = _c.sent();
if ((0, lodash_1.isNil)(document))
return [2 /*return*/];
_a = this.set;
_b = {};
return [4 /*yield*/, document.__generateKeywords()];
case 2:
_a.apply(this, [(_b.__keywords = _c.sent(), _b)]);
return [2 /*return*/];
}
});
});
});
};
exports.KeywordsMiddleware = KeywordsMiddleware;
//# sourceMappingURL=keywords.plugin.js.map