123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331 |
- 'use strict';
- /*!
- * Module dependencies.
- */
- const CastError = require('../error/cast');
- const EventEmitter = require('events').EventEmitter;
- const ObjectExpectedError = require('../error/objectExpected');
- const SchemaType = require('../schematype');
- const $exists = require('./operators/exists');
- const castToNumber = require('./operators/helpers').castToNumber;
- const discriminator = require('../helpers/model/discriminator');
- const geospatial = require('./operators/geospatial');
- const get = require('../helpers/get');
- const getDiscriminatorByValue = require('../queryhelpers').getDiscriminatorByValue;
- const internalToObjectOptions = require('../options').internalToObjectOptions;
- let Subdocument;
- module.exports = Embedded;
- /**
- * Sub-schema schematype constructor
- *
- * @param {Schema} schema
- * @param {String} key
- * @param {Object} options
- * @inherits SchemaType
- * @api public
- */
- function Embedded(schema, path, options) {
- this.caster = _createConstructor(schema);
- this.caster.path = path;
- this.caster.prototype.$basePath = path;
- this.schema = schema;
- this.$isSingleNested = true;
- SchemaType.call(this, path, options, 'Embedded');
- }
- /*!
- * ignore
- */
- Embedded.prototype = Object.create(SchemaType.prototype);
- Embedded.prototype.constructor = Embedded;
- /*!
- * ignore
- */
- function _createConstructor(schema) {
- // lazy load
- Subdocument || (Subdocument = require('../types/subdocument'));
- const _embedded = function SingleNested(value, path, parent) {
- const _this = this;
- this.$parent = parent;
- Subdocument.apply(this, arguments);
- this.$session(this.ownerDocument().$session());
- if (parent) {
- parent.on('save', function() {
- _this.emit('save', _this);
- _this.constructor.emit('save', _this);
- });
- parent.on('isNew', function(val) {
- _this.isNew = val;
- _this.emit('isNew', val);
- _this.constructor.emit('isNew', val);
- });
- }
- };
- _embedded.prototype = Object.create(Subdocument.prototype);
- _embedded.prototype.$__setSchema(schema);
- _embedded.prototype.constructor = _embedded;
- _embedded.schema = schema;
- _embedded.$isSingleNested = true;
- _embedded.events = new EventEmitter();
- _embedded.prototype.toBSON = function() {
- return this.toObject(internalToObjectOptions);
- };
- // apply methods
- for (const i in schema.methods) {
- _embedded.prototype[i] = schema.methods[i];
- }
- // apply statics
- for (const i in schema.statics) {
- _embedded[i] = schema.statics[i];
- }
- for (const i in EventEmitter.prototype) {
- _embedded[i] = EventEmitter.prototype[i];
- }
- return _embedded;
- }
- /*!
- * Special case for when users use a common location schema to represent
- * locations for use with $geoWithin.
- * https://docs.mongodb.org/manual/reference/operator/query/geoWithin/
- *
- * @param {Object} val
- * @api private
- */
- Embedded.prototype.$conditionalHandlers.$geoWithin = function handle$geoWithin(val) {
- return { $geometry: this.castForQuery(val.$geometry) };
- };
- /*!
- * ignore
- */
- Embedded.prototype.$conditionalHandlers.$near =
- Embedded.prototype.$conditionalHandlers.$nearSphere = geospatial.cast$near;
- Embedded.prototype.$conditionalHandlers.$within =
- Embedded.prototype.$conditionalHandlers.$geoWithin = geospatial.cast$within;
- Embedded.prototype.$conditionalHandlers.$geoIntersects =
- geospatial.cast$geoIntersects;
- Embedded.prototype.$conditionalHandlers.$minDistance = castToNumber;
- Embedded.prototype.$conditionalHandlers.$maxDistance = castToNumber;
- Embedded.prototype.$conditionalHandlers.$exists = $exists;
- /**
- * Casts contents
- *
- * @param {Object} value
- * @api private
- */
- Embedded.prototype.cast = function(val, doc, init, priorVal) {
- if (val && val.$isSingleNested) {
- return val;
- }
- if (val != null && (typeof val !== 'object' || Array.isArray(val))) {
- throw new ObjectExpectedError(this.path, val);
- }
- let Constructor = this.caster;
- const discriminatorKey = Constructor.schema.options.discriminatorKey;
- if (val != null &&
- Constructor.discriminators &&
- typeof val[discriminatorKey] === 'string') {
- if (Constructor.discriminators[val[discriminatorKey]]) {
- Constructor = Constructor.discriminators[val[discriminatorKey]];
- } else {
- const constructorByValue = getDiscriminatorByValue(Constructor, val[discriminatorKey]);
- if (constructorByValue) {
- Constructor = constructorByValue;
- }
- }
- }
- let subdoc;
- // Only pull relevant selected paths and pull out the base path
- const parentSelected = get(doc, '$__.selected', {});
- const path = this.path;
- const selected = Object.keys(parentSelected).reduce((obj, key) => {
- if (key.startsWith(path + '.')) {
- obj[key.substr(path.length + 1)] = parentSelected[key];
- }
- return obj;
- }, {});
- if (init) {
- subdoc = new Constructor(void 0, selected, doc);
- subdoc.init(val);
- } else {
- if (Object.keys(val).length === 0) {
- return new Constructor({}, selected, doc);
- }
- return new Constructor(val, selected, doc, undefined, { priorDoc: priorVal });
- }
- return subdoc;
- };
- /**
- * Casts contents for query
- *
- * @param {string} [$conditional] optional query operator (like `$eq` or `$in`)
- * @param {any} value
- * @api private
- */
- Embedded.prototype.castForQuery = function($conditional, val) {
- let handler;
- if (arguments.length === 2) {
- handler = this.$conditionalHandlers[$conditional];
- if (!handler) {
- throw new Error('Can\'t use ' + $conditional);
- }
- return handler.call(this, val);
- }
- val = $conditional;
- if (val == null) {
- return val;
- }
- if (this.options.runSetters) {
- val = this._applySetters(val);
- }
- let Constructor = this.caster;
- const discriminatorKey = Constructor.schema.options.discriminatorKey;
- if (val != null &&
- Constructor.discriminators &&
- typeof val[discriminatorKey] === 'string') {
- if (Constructor.discriminators[val[discriminatorKey]]) {
- Constructor = Constructor.discriminators[val[discriminatorKey]];
- } else {
- const constructorByValue = getDiscriminatorByValue(Constructor, val[discriminatorKey]);
- if (constructorByValue) {
- Constructor = constructorByValue;
- }
- }
- }
- try {
- val = new Constructor(val);
- } catch (error) {
- // Make sure we always wrap in a CastError (gh-6803)
- if (!(error instanceof CastError)) {
- throw new CastError('Embedded', val, this.path, error);
- }
- throw error;
- }
- return val;
- };
- /**
- * Async validation on this single nested doc.
- *
- * @api private
- */
- Embedded.prototype.doValidate = function(value, fn, scope, options) {
- let Constructor = this.caster;
- const discriminatorKey = Constructor.schema.options.discriminatorKey;
- if (value != null &&
- Constructor.discriminators &&
- typeof value[discriminatorKey] === 'string') {
- if (Constructor.discriminators[value[discriminatorKey]]) {
- Constructor = Constructor.discriminators[value[discriminatorKey]];
- } else {
- const constructorByValue = getDiscriminatorByValue(Constructor, value[discriminatorKey]);
- if (constructorByValue) {
- Constructor = constructorByValue;
- }
- }
- }
- if (options && options.skipSchemaValidators) {
- if (!(value instanceof Constructor)) {
- value = new Constructor(value, null, scope);
- }
- return value.validate(fn);
- }
- SchemaType.prototype.doValidate.call(this, value, function(error) {
- if (error) {
- return fn(error);
- }
- if (!value) {
- return fn(null);
- }
- value.validate(fn);
- }, scope);
- };
- /**
- * Synchronously validate this single nested doc
- *
- * @api private
- */
- Embedded.prototype.doValidateSync = function(value, scope, options) {
- if (!options || !options.skipSchemaValidators) {
- const schemaTypeError = SchemaType.prototype.doValidateSync.call(this, value, scope);
- if (schemaTypeError) {
- return schemaTypeError;
- }
- }
- if (!value) {
- return;
- }
- return value.validateSync();
- };
- /**
- * Adds a discriminator to this property
- *
- * @param {String} name
- * @param {Schema} schema fields to add to the schema for instances of this sub-class
- * @api public
- */
- Embedded.prototype.discriminator = function(name, schema) {
- discriminator(this.caster, name, schema);
- this.caster.discriminators[name] = _createConstructor(schema);
- return this.caster.discriminators[name];
- };
- /*!
- * ignore
- */
- Embedded.prototype.clone = function() {
- const options = Object.assign({}, this.options, { validators: this.validators });
- return new this.constructor(this.schema, this.path, options);
- };
|