objectid.js
7.46 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
/*!
* Module dependencies.
*/
'use strict';
const SchemaObjectIdOptions = require('../options/SchemaObjectIdOptions');
const SchemaType = require('../schematype');
const castObjectId = require('../cast/objectid');
const oid = require('../types/objectid');
const utils = require('../utils');
const populateModelSymbol = require('../helpers/symbols').populateModelSymbol;
const CastError = SchemaType.CastError;
let Document;
/**
* ObjectId SchemaType constructor.
*
* @param {String} key
* @param {Object} options
* @inherits SchemaType
* @api public
*/
function ObjectId(key, options) {
const isKeyHexStr = typeof key === 'string' && key.length === 24 && /^[a-f0-9]+$/i.test(key);
const suppressWarning = options && options.suppressWarning;
if ((isKeyHexStr || typeof key === 'undefined') && !suppressWarning) {
console.warn('mongoose: To create a new ObjectId please try ' +
'`Mongoose.Types.ObjectId` instead of using ' +
'`Mongoose.Schema.ObjectId`. Set the `suppressWarning` option if ' +
'you\'re trying to create a hex char path in your schema.');
console.trace();
}
SchemaType.call(this, key, options, 'ObjectID');
}
/**
* This schema type's name, to defend against minifiers that mangle
* function names.
*
* @api public
*/
ObjectId.schemaName = 'ObjectId';
ObjectId.defaultOptions = {};
/*!
* Inherits from SchemaType.
*/
ObjectId.prototype = Object.create(SchemaType.prototype);
ObjectId.prototype.constructor = ObjectId;
ObjectId.prototype.OptionsConstructor = SchemaObjectIdOptions;
/**
* Attaches a getter for all ObjectId instances
*
* ####Example:
*
* // Always convert to string when getting an ObjectId
* mongoose.ObjectId.get(v => v.toString());
*
* const Model = mongoose.model('Test', new Schema({}));
* typeof (new Model({})._id); // 'string'
*
* @param {Function} getter
* @return {this}
* @function get
* @static
* @api public
*/
ObjectId.get = SchemaType.get;
/**
* Sets a default option for all ObjectId instances.
*
* ####Example:
*
* // Make all object ids have option `required` equal to true.
* mongoose.Schema.ObjectId.set('required', true);
*
* const Order = mongoose.model('Order', new Schema({ userId: ObjectId }));
* new Order({ }).validateSync().errors.userId.message; // Path `userId` is required.
*
* @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
*/
ObjectId.set = SchemaType.set;
/**
* Adds an auto-generated ObjectId default if turnOn is true.
* @param {Boolean} turnOn auto generated ObjectId defaults
* @api public
* @return {SchemaType} this
*/
ObjectId.prototype.auto = function(turnOn) {
if (turnOn) {
this.default(defaultId);
this.set(resetId);
}
return this;
};
/*!
* ignore
*/
ObjectId._checkRequired = v => v instanceof oid;
/*!
* ignore
*/
ObjectId._cast = castObjectId;
/**
* Get/set the function used to cast arbitrary values to objectids.
*
* ####Example:
*
* // Make Mongoose only try to cast length 24 strings. By default, any 12
* // char string is a valid ObjectId.
* const original = mongoose.ObjectId.cast();
* mongoose.ObjectId.cast(v => {
* assert.ok(typeof v !== 'string' || v.length === 24);
* return original(v);
* });
*
* // Or disable casting entirely
* mongoose.ObjectId.cast(false);
*
* @param {Function} caster
* @return {Function}
* @function get
* @static
* @api public
*/
ObjectId.cast = function cast(caster) {
if (arguments.length === 0) {
return this._cast;
}
if (caster === false) {
caster = v => {
if (!(v instanceof oid)) {
throw new Error(v + ' is not an instance of ObjectId');
}
return v;
};
}
this._cast = caster;
return this._cast;
};
/**
* Override the function the required validator uses to check whether a string
* passes the `required` check.
*
* ####Example:
*
* // Allow empty strings to pass `required` check
* mongoose.Schema.Types.String.checkRequired(v => v != null);
*
* const M = mongoose.model({ str: { type: String, required: true } });
* new M({ str: '' }).validateSync(); // `null`, validation passes!
*
* @param {Function} fn
* @return {Function}
* @function checkRequired
* @static
* @api public
*/
ObjectId.checkRequired = SchemaType.checkRequired;
/**
* Check if the given value satisfies a required validator.
*
* @param {Any} value
* @param {Document} doc
* @return {Boolean}
* @api public
*/
ObjectId.prototype.checkRequired = function checkRequired(value, doc) {
if (SchemaType._isRef(this, value, doc, true)) {
return !!value;
}
// `require('util').inherits()` does **not** copy static properties, and
// plugins like mongoose-float use `inherits()` for pre-ES6.
const _checkRequired = typeof this.constructor.checkRequired == 'function' ?
this.constructor.checkRequired() :
ObjectId.checkRequired();
return _checkRequired(value);
};
/**
* Casts to ObjectId
*
* @param {Object} value
* @param {Object} doc
* @param {Boolean} init whether this is an initialization cast
* @api private
*/
ObjectId.prototype.cast = function(value, doc, init) {
if (SchemaType._isRef(this, value, doc, init)) {
// wait! we may need to cast this to a document
if (value === null || value === undefined) {
return value;
}
// lazy load
Document || (Document = require('./../document'));
if (value instanceof Document) {
value.$__.wasPopulated = true;
return value;
}
// setting a populated path
if (value instanceof oid) {
return value;
} else if ((value.constructor.name || '').toLowerCase() === 'objectid') {
return new oid(value.toHexString());
} else if (Buffer.isBuffer(value) || !utils.isObject(value)) {
throw new CastError('ObjectId', value, this.path, null, this);
}
// Handle the case where user directly sets a populated
// path to a plain object; cast to the Model used in
// the population query.
const path = doc.$__fullPath(this.path);
const owner = doc.ownerDocument ? doc.ownerDocument() : doc;
const pop = owner.populated(path, true);
let ret = value;
if (!doc.$__.populated ||
!doc.$__.populated[path] ||
!doc.$__.populated[path].options ||
!doc.$__.populated[path].options.options ||
!doc.$__.populated[path].options.options.lean) {
ret = new pop.options[populateModelSymbol](value);
ret.$__.wasPopulated = true;
}
return ret;
}
const castObjectId = typeof this.constructor.cast === 'function' ?
this.constructor.cast() :
ObjectId.cast();
try {
return castObjectId(value);
} catch (error) {
throw new CastError('ObjectId', value, this.path, error, this);
}
};
/*!
* ignore
*/
function handleSingle(val) {
return this.cast(val);
}
ObjectId.prototype.$conditionalHandlers =
utils.options(SchemaType.prototype.$conditionalHandlers, {
$gt: handleSingle,
$gte: handleSingle,
$lt: handleSingle,
$lte: handleSingle
});
/*!
* ignore
*/
function defaultId() {
return new oid();
}
defaultId.$runBeforeSetters = true;
function resetId(v) {
Document || (Document = require('./../document'));
if (this instanceof Document) {
if (v === void 0) {
const _v = new oid;
this.$__._id = _v;
return _v;
}
this.$__._id = v;
}
return v;
}
/*!
* Module exports.
*/
module.exports = ObjectId;