Commit

node_modules/mongoose/lib/schema/boolean.js

@@ -0,0 +1,332 @@
+'use strict';
+
+/*!
+ * Module dependencies.
+ */
+
+const CastError = require('../error/cast');
+const SchemaType = require('../schemaType');
+const castBoolean = require('../cast/boolean');
+const createJSONSchemaTypeDefinition = require('../helpers/createJSONSchemaTypeDefinition');
+
+/**
+ * Boolean SchemaType constructor.
+ *
+ * @param {String} path
+ * @param {Object} options
+ * @param {Object} schemaOptions
+ * @param {Schema} parentSchema
+ * @inherits SchemaType
+ * @api public
+ */
+
+function SchemaBoolean(path, options, _schemaOptions, parentSchema) {
+  SchemaType.call(this, path, options, 'Boolean', parentSchema);
+}
+
+/**
+ * This schema type's name, to defend against minifiers that mangle
+ * function names.
+ *
+ * @api public
+ */
+SchemaBoolean.schemaName = 'Boolean';
+
+SchemaBoolean.defaultOptions = {};
+
+/*!
+ * Inherits from SchemaType.
+ */
+SchemaBoolean.prototype = Object.create(SchemaType.prototype);
+SchemaBoolean.prototype.constructor = SchemaBoolean;
+
+/*!
+ * ignore
+ */
+
+SchemaBoolean._cast = castBoolean;
+
+/**
+ * Sets a default option for all Boolean instances.
+ *
+ * #### Example:
+ *
+ *     // Make all booleans have `default` of false.
+ *     mongoose.Schema.Boolean.set('default', false);
+ *
+ *     const Order = mongoose.model('Order', new Schema({ isPaid: Boolean }));
+ *     new Order({ }).isPaid; // false
+ *
+ * @param {String} option The option you'd like to set the value for
+ * @param {Any} value value for option
+ * @return {undefined}
+ * @function set
+ * @static
+ * @api public
+ */
+
+SchemaBoolean.set = SchemaType.set;
+
+SchemaBoolean.setters = [];
+
+/**
+ * Attaches a getter for all Boolean instances
+ *
+ * #### Example:
+ *
+ *     mongoose.Schema.Boolean.get(v => v === true ? 'yes' : 'no');
+ *
+ *     const Order = mongoose.model('Order', new Schema({ isPaid: Boolean }));
+ *     new Order({ isPaid: false }).isPaid; // 'no'
+ *
+ * @param {Function} getter
+ * @return {this}
+ * @function get
+ * @static
+ * @api public
+ */
+
+SchemaBoolean.get = SchemaType.get;
+
+/**
+ * Get/set the function used to cast arbitrary values to booleans.
+ *
+ * #### Example:
+ *
+ *     // Make Mongoose cast empty string '' to false.
+ *     const original = mongoose.Schema.Boolean.cast();
+ *     mongoose.Schema.Boolean.cast(v => {
+ *       if (v === '') {
+ *         return false;
+ *       }
+ *       return original(v);
+ *     });
+ *
+ *     // Or disable casting entirely
+ *     mongoose.Schema.Boolean.cast(false);
+ *
+ * @param {Function} caster
+ * @return {Function}
+ * @function cast
+ * @static
+ * @api public
+ */
+
+SchemaBoolean.cast = function cast(caster) {
+  if (arguments.length === 0) {
+    return this._cast;
+  }
+  if (caster === false) {
+    caster = this._defaultCaster;
+  }
+  this._cast = caster;
+
+  return this._cast;
+};
+
+/*!
+ * ignore
+ */
+
+SchemaBoolean._defaultCaster = v => {
+  if (v != null && typeof v !== 'boolean') {
+    throw new Error();
+  }
+  return v;
+};
+
+/*!
+ * ignore
+ */
+
+SchemaBoolean._checkRequired = v => v === true || v === false;
+
+/**
+ * Override the function the required validator uses to check whether a boolean
+ * passes the `required` check.
+ *
+ * @param {Function} fn
+ * @return {Function}
+ * @function checkRequired
+ * @static
+ * @api public
+ */
+
+SchemaBoolean.checkRequired = SchemaType.checkRequired;
+
+/**
+ * Check if the given value satisfies a required validator. For a boolean
+ * to satisfy a required validator, it must be strictly equal to true or to
+ * false.
+ *
+ * @param {Any} value
+ * @return {Boolean}
+ * @api public
+ */
+
+SchemaBoolean.prototype.checkRequired = function(value) {
+  return this.constructor._checkRequired(value);
+};
+
+/**
+ * Configure which values get casted to `true`.
+ *
+ * #### Example:
+ *
+ *     const M = mongoose.model('Test', new Schema({ b: Boolean }));
+ *     new M({ b: 'affirmative' }).b; // undefined
+ *     mongoose.Schema.Boolean.convertToTrue.add('affirmative');
+ *     new M({ b: 'affirmative' }).b; // true
+ *
+ * @property convertToTrue
+ * @static
+ * @memberOf SchemaBoolean
+ * @type {Set}
+ * @api public
+ */
+
+Object.defineProperty(SchemaBoolean, 'convertToTrue', {
+  get: () => castBoolean.convertToTrue,
+  set: v => { castBoolean.convertToTrue = v; }
+});
+
+/**
+ * Configure which values get casted to `false`.
+ *
+ * #### Example:
+ *
+ *     const M = mongoose.model('Test', new Schema({ b: Boolean }));
+ *     new M({ b: 'nay' }).b; // undefined
+ *     mongoose.Schema.Types.Boolean.convertToFalse.add('nay');
+ *     new M({ b: 'nay' }).b; // false
+ *
+ * @property convertToFalse
+ * @static
+ * @memberOf SchemaBoolean
+ * @type {Set}
+ * @api public
+ */
+
+Object.defineProperty(SchemaBoolean, 'convertToFalse', {
+  get: () => castBoolean.convertToFalse,
+  set: v => { castBoolean.convertToFalse = v; }
+});
+
+/**
+ * Casts to boolean
+ *
+ * @param {Object} value
+ * @param {Object} model this value is optional
+ * @api private
+ */
+
+SchemaBoolean.prototype.cast = function(value) {
+  let castBoolean;
+  if (typeof this._castFunction === 'function') {
+    castBoolean = this._castFunction;
+  } else if (typeof this.constructor.cast === 'function') {
+    castBoolean = this.constructor.cast();
+  } else {
+    castBoolean = SchemaBoolean.cast();
+  }
+
+  try {
+    return castBoolean(value);
+  } catch (error) {
+    throw new CastError('Boolean', value, this.path, error, this);
+  }
+};
+
+const $conditionalHandlers = { ...SchemaType.prototype.$conditionalHandlers };
+
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$in` is the function Mongoose calls to cast `$in` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @memberOf SchemaBoolean
+ * @instance
+ * @api public
+ */
+
+Object.defineProperty(SchemaBoolean.prototype, '$conditionalHandlers', {
+  enumerable: false,
+  value: $conditionalHandlers
+});
+
+/**
+ * Casts contents for queries.
+ *
+ * @param {String} $conditional
+ * @param {any} val
+ * @api private
+ */
+
+SchemaBoolean.prototype.castForQuery = function($conditional, val, context) {
+  let handler;
+  if ($conditional != null) {
+    handler = this.$conditionalHandlers[$conditional];
+
+    if (handler) {
+      return handler.call(this, val);
+    }
+
+    return this.applySetters(val, context);
+  }
+
+  try {
+    return this.applySetters(val, context);
+  } catch (err) {
+    if (err instanceof CastError && err.path === this.path && this.$fullPath != null) {
+      err.path = this.$fullPath;
+    }
+    throw err;
+  }
+};
+
+/**
+ *
+ * @api private
+ */
+
+SchemaBoolean.prototype._castNullish = function _castNullish(v) {
+  if (typeof v === 'undefined') {
+    return v;
+  }
+  const castBoolean = typeof this.constructor.cast === 'function' ?
+    this.constructor.cast() :
+    SchemaBoolean.cast();
+  if (castBoolean == null) {
+    return v;
+  }
+  if (castBoolean.convertToFalse instanceof Set && castBoolean.convertToFalse.has(v)) {
+    return false;
+  }
+  if (castBoolean.convertToTrue instanceof Set && castBoolean.convertToTrue.has(v)) {
+    return true;
+  }
+  return v;
+};
+
+/**
+ * Returns this schema type's representation in a JSON schema.
+ *
+ * @param [options]
+ * @param [options.useBsonType=false] If true, return a representation with `bsonType` for use with MongoDB's `$jsonSchema`.
+ * @returns {Object} JSON schema properties
+ */
+
+SchemaBoolean.prototype.toJSONSchema = function toJSONSchema(options) {
+  const isRequired = this.options.required && typeof this.options.required !== 'function';
+  return createJSONSchemaTypeDefinition('boolean', 'bool', options?.useBsonType, isRequired);
+};
+
+SchemaBoolean.prototype.autoEncryptionType = function autoEncryptionType() {
+  return 'bool';
+};
+
+/*!
+ * Module exports.
+ */
+
+module.exports = SchemaBoolean;