SingleNestedPath.js
9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
'use strict';
/*!
* Module dependencies.
*/
const CastError = require('../error/cast');
const EventEmitter = require('events').EventEmitter;
const ObjectExpectedError = require('../error/objectExpected');
const SchemaSingleNestedOptions = require('../options/SchemaSingleNestedOptions');
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 getConstructor = require('../helpers/discriminator/getConstructor');
const handleIdOption = require('../helpers/schema/handleIdOption');
const internalToObjectOptions = require('../options').internalToObjectOptions;
let Subdocument;
module.exports = SingleNestedPath;
/**
* Single nested subdocument SchemaType constructor.
*
* @param {Schema} schema
* @param {String} key
* @param {Object} options
* @inherits SchemaType
* @api public
*/
function SingleNestedPath(schema, path, options) {
schema = handleIdOption(schema, 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
*/
SingleNestedPath.prototype = Object.create(SchemaType.prototype);
SingleNestedPath.prototype.constructor = SingleNestedPath;
SingleNestedPath.prototype.OptionsConstructor = SchemaSingleNestedOptions;
/*!
* ignore
*/
function _createConstructor(schema, baseClass) {
// 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);
});
}
};
const proto = baseClass != null ? baseClass.prototype : Subdocument.prototype;
_embedded.prototype = Object.create(proto);
_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
*/
SingleNestedPath.prototype.$conditionalHandlers.$geoWithin = function handle$geoWithin(val) {
return { $geometry: this.castForQuery(val.$geometry) };
};
/*!
* ignore
*/
SingleNestedPath.prototype.$conditionalHandlers.$near =
SingleNestedPath.prototype.$conditionalHandlers.$nearSphere = geospatial.cast$near;
SingleNestedPath.prototype.$conditionalHandlers.$within =
SingleNestedPath.prototype.$conditionalHandlers.$geoWithin = geospatial.cast$within;
SingleNestedPath.prototype.$conditionalHandlers.$geoIntersects =
geospatial.cast$geoIntersects;
SingleNestedPath.prototype.$conditionalHandlers.$minDistance = castToNumber;
SingleNestedPath.prototype.$conditionalHandlers.$maxDistance = castToNumber;
SingleNestedPath.prototype.$conditionalHandlers.$exists = $exists;
/**
* Casts contents
*
* @param {Object} value
* @api private
*/
SingleNestedPath.prototype.cast = function(val, doc, init, priorVal) {
if (val && val.$isSingleNested && val.parent === doc) {
return val;
}
if (val != null && (typeof val !== 'object' || Array.isArray(val))) {
throw new ObjectExpectedError(this.path, val);
}
const Constructor = getConstructor(this.caster, val);
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, undefined, { priorDoc: priorVal });
}
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
*/
SingleNestedPath.prototype.castForQuery = function($conditional, val, options) {
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);
}
const Constructor = getConstructor(this.caster, val);
const overrideStrict = options != null && options.strict != null ?
options.strict :
void 0;
try {
val = new Constructor(val, overrideStrict);
} catch (error) {
// Make sure we always wrap in a CastError (gh-6803)
if (!(error instanceof CastError)) {
throw new CastError('Embedded', val, this.path, error, this);
}
throw error;
}
return val;
};
/**
* Async validation on this single nested doc.
*
* @api private
*/
SingleNestedPath.prototype.doValidate = function(value, fn, scope, options) {
const Constructor = getConstructor(this.caster, value);
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, options);
};
/**
* Synchronously validate this single nested doc
*
* @api private
*/
SingleNestedPath.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 single nested subdocument.
*
* ####Example:
* const shapeSchema = Schema({ name: String }, { discriminatorKey: 'kind' });
* const schema = Schema({ shape: shapeSchema });
*
* const singleNestedPath = parentSchema.path('shape');
* singleNestedPath.discriminator('Circle', Schema({ radius: Number }));
*
* @param {String} name
* @param {Schema} schema fields to add to the schema for instances of this sub-class
* @param {String} [value] the string stored in the `discriminatorKey` property. If not specified, Mongoose uses the `name` parameter.
* @return {Function} the constructor Mongoose will use for creating instances of this discriminator model
* @see discriminators /docs/discriminators.html
* @api public
*/
SingleNestedPath.prototype.discriminator = function(name, schema, value) {
schema = discriminator(this.caster, name, schema, value);
this.caster.discriminators[name] = _createConstructor(schema, this.caster);
return this.caster.discriminators[name];
};
/**
* Sets a default option for all SingleNestedPath instances.
*
* ####Example:
*
* // Make all numbers have option `min` equal to 0.
* mongoose.Schema.Embedded.set('required', true);
*
* @param {String} option - The option you'd like to set the value for
* @param {*} value - value for option
* @return {undefined}
* @function set
* @static
* @api public
*/
SingleNestedPath.defaultOptions = {};
SingleNestedPath.set = SchemaType.set;
/*!
* ignore
*/
SingleNestedPath.prototype.clone = function() {
const options = Object.assign({}, this.options);
const schematype = new this.constructor(this.schema, this.path, options);
schematype.validators = this.validators.slice();
if (this.requiredValidator !== undefined) {
schematype.requiredValidator = this.requiredValidator;
}
schematype.caster.discriminators = Object.assign({}, this.caster.discriminators);
return schematype;
};