# all files / keystone/fields/types/ Type.js

49.4% Statements 82/166
27.2% Branches 34/125
36.59% Functions 15/41
53.38% Lines 79/148

    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
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357

    1×
    1×
    1×
    1×
    1×
    1×
    1×
    1×

    1×

    1×

    97×
    97×
    97×

    97×
    97×
    97×
    97×

    97×

    97×

    97×
    1×
    1×

    3×
    3×

    97×

    97×

    97×
    97×

    1×

    1×

    1×

    1×

    1×

    1×

    1×
    1×
    27×
    1×
    1×
    27×
    1×
    1×
    1×
    1×
    1×
    1×

    1×
    71×
    71×
    71×

    1×
    97×
    97×
    214×
    117×

    214×

    214×
    26×
    26×

    1×
    215×
    26×

    1×
    16×
    16×
    16×

    1×
    16×

    1×

    1×

    1×
    7×

    1×
    30×

    30×
    30×

    30×

    1×
    814×

     /*!
     * Module dependencies.
     */
    var _ = require('lodash');
    var assign = require('object-assign');
    var di = require('asyncdi');
    var marked = require('marked');
    var Path = require('../../lib/path');
    var utils = require('keystone-utils');
    var evalDependsOn = require('../utils/evalDependsOn.js');
    var debug = require('debug')('keystone:fields:types:Type');

    var DEFAULT_OPTION_KEYS = [
    	'path',
    	'paths',
    	'type',
    	'label',
    	'note',
    	'size',
    	'initial',
    	'required',
    	'col',
    	'noedit',
    	'nocol',
    	'nosort',
    	'nofilter',
    	'indent',
    	'hidden',
    	'collapse',
    	'dependsOn',
    ];

    /**
     * Field Constructor
     * =================
     *
     * Extended by fieldType Classes, should not be used directly.
     *
     * @api public
     */
    function Field (list, path, options) {

    	// Set field properties and options
    	this.list = list;
    	this._path = new Path(path);
    	this.path = path;

    	this.type = this.constructor.name;
    	this.options = utils.options(this.defaults, options);
    	this.label = options.label || utils.keyToLabel(this.path);
    	this.typeDescription = options.typeDescription || this.typeDescription || this.type;

    	this.list.automap(this);

    	// Warn on required fields that aren't initial
    	Iif (this.options.required
    		&& this.options.initial === undefined
    		&& this.options.default === undefined
    		&& !this.options.value
    		&& !this.list.get('nocreate')
    		&& this.path !== this.list.mappings.name
    	) {
    		console.error('\nError: Invalid Configuration\n\n'
    		+ 'Field (' + list.key + '.' + path + ') is required but not initial, and has no default or generated value.\n'
    		+ 'Please provide a default, remove the required setting, or set initial: false to override this error.\n');
    		process.exit(1);
    	}

    	// if dependsOn and required, set required to a function for validation
    	if (this.options.dependsOn && this.options.required === true) {
    		var opts = this.options;
    		this.options.required = function () {
    			// `this` refers to the validating document
    			debug('validate dependsOn required', evalDependsOn(opts.dependsOn, this.toObject()));
    			return evalDependsOn(opts.dependsOn, this.toObject());
    		};
    	}

    	// Add the field to the schema
    	this.addToSchema();

    	// Add pre-save handler to the list if this field watches others
    	Iif (this.options.watch) {
    		this.list.schema.pre('save', this.getPreSaveWatcher());
    	}

    	// Convert notes from markdown to html
    	var note = null;
    	Object.defineProperty(this, 'note', {
    		get: function () {
    			return (note === null) ? (note = (this.options.note) ? marked(this.options.note) : '') : note;
    		},
    	});

    }

    /**
     * Gets the options for the Field, as used by the React components
     */
    Field.prototype.getOptions = function () {
    	if (!this.__options) {
    		this.__options = {};
    		var optionKeys = DEFAULT_OPTION_KEYS;
    		if (_.isArray(this._properties)) {
    			optionKeys = optionKeys.concat(this._properties);
    		}
    		optionKeys.forEach(function (key) {
    			if (this[key]) {
    				this.__options[key] = this[key];
    			} else if (this.options[key]) {
    				this.__options[key] = this.options[key];
    			}
    		}, this);
    		if (this.getProperties) {
    			assign(this.__options, this.getProperties());
    		}
    		this.__options.hasFilterMethod = this.addFilterToQuery ? true : false;
    		this.__options.defaultValue = this.getDefaultValue();
    	}
    	return this.__options;
    };

    /**
     * Validates and returns the size of the field.
     * Defaults to deprecated 'width' option.
     */
    Field.prototype.getSize = function () {
    	if (!this.__size) {
    		var size = this._fixedSize || this.options.size || this.options.width;
    		if (size !== 'small' && size !== 'medium' && size !== 'large' && size !== 'full') {
    			size = this._defaultSize || 'full';
    		}
    		this.__size = size;
    	}
    	return this.__size;
    };

    /**
     * Gets default value for the field, based on the option or default for the type
     */
    Field.prototype.getDefaultValue = function () {
    	return this.options.default || '';
    };

    /**
     * Gets the field's data from an Item, as used by the React components
     */
    Field.prototype.getData = function (item) {
    	return item.get(this.path);
    };

    /**
     * Field watching implementation
     */
    Field.prototype.getPreSaveWatcher = function () {
    	var field = this;
    	var applyValue;

    	if (this.options.watch === true) {
    		// watch == true means always apply the value method
    		applyValue = function () { return true; };
    	} else {
    		// if watch is a string, convert it to a list of paths to watch
    		if (_.isString(this.options.watch)) {
    			this.options.watch = this.options.watch.split(' ');
    		}
    		if (_.isFunction(this.options.watch)) {
    			applyValue = this.options.watch;
    		} else if (_.isArray(this.options.watch)) {
    			applyValue = function (item) {
    				var pass = false;
    				field.options.watch.forEach(function (path) {
    					if (item.isModified(path)) pass = true;
    				});
    				return pass;
    			};
    		} else if (_.isObject(this.options.watch)) {
    			applyValue = function (item) {
    				var pass = false;
    				_.forEach(field.options.watch, function (value, path) {
    					if (item.isModified(path) && item.get(path) === value) pass = true;
    				});
    				return pass;
    			};
    		}
    	}

    	if (!applyValue) {
    		console.error('\nError: Invalid Configuration\n\n'
    		+ 'Invalid watch value (' + this.options.watch + ') provided for ' + this.list.key + '.' + this.path + ' (' + this.type + ')');
    		process.exit(1);
    	}

    	if (!_.isFunction(this.options.value)) {
    		console.error('\nError: Invalid Configuration\n\n'
    		+ 'Watch set with no value method provided for ' + this.list.key + '.' + this.path + ' (' + this.type + ')');
    		process.exit(1);
    	}

    	return function (next) {
    		if (!applyValue(this)) {
    			return next();
    		}
    		di(field.options.value).call(this, function (err, val) {
    			if (err) {
    				console.error('\nError: '
    				+ 'Watch set with value method for ' + field.list.key + '.' + field.path + ' (' + field.type + ') throws error:' + err);
    			} else {
    				this.set(field.path, val);
    			}
    			next();
    		}.bind(this));
    	};

    };
    module.exports = Field;

    /** Getter properties for the Field prototype */
    Object.defineProperty(Field.prototype, 'size', { get: function () { return this.getSize(); } });
    Object.defineProperty(Field.prototype, 'initial', { get: function () { return this.options.initial || false; } });
    Object.defineProperty(Field.prototype, 'required', { get: function () { return this.options.required || false; } });
    Object.defineProperty(Field.prototype, 'note', { get: function () { return this.options.note || ''; } });
    Object.defineProperty(Field.prototype, 'col', { get: function () { return this.options.col || false; } });
    Object.defineProperty(Field.prototype, 'noedit', { get: function () { return this.options.noedit || false; } });
    Object.defineProperty(Field.prototype, 'nocol', { get: function () { return this.options.nocol || false; } });
    Object.defineProperty(Field.prototype, 'nosort', { get: function () { return this.options.nosort || false; } });
    Object.defineProperty(Field.prototype, 'nofilter', { get: function () { return this.options.nofilter || false; } });
    Object.defineProperty(Field.prototype, 'collapse', { get: function () { return this.options.collapse || false; } });
    Object.defineProperty(Field.prototype, 'hidden', { get: function () { return this.options.hidden || false; } });
    Object.defineProperty(Field.prototype, 'dependsOn', { get: function () { return this.options.dependsOn || false; } });

    /**
     * Default method to register the field on the List's Mongoose Schema.
     * Overridden by some fieldType Classes
     */
    Field.prototype.addToSchema = function () {
    	var ops = (this._nativeType) ? _.defaults({ type: this._nativeType }, this.options) : this.options;
    	this.list.schema.path(this.path, ops);
    	this.bindUnderscoreMethods();
    };

    /**
     * Binds the methods specified by the _underscoreMethods property
     * Must be called by the field type's `addToSchema` method
     * Always includes the `update` method
     */
    Field.prototype.bindUnderscoreMethods = function (methods) {
    	var field = this;
    	(this._underscoreMethods || []).concat({ fn: 'updateItem', as: 'update' }, (methods || [])).forEach(function (method) {
    		if (typeof method === 'string') {
    			method = { fn: method, as: method };
    		}
    		Iif (typeof field[method.fn] !== 'function') {
    			throw new Error('Invalid underscore method (' + method.fn + ') applied to ' + field.list.key + '.' + field.path + ' (' + field.type + ')');
    		}
    		field.underscoreMethod(method.as, function () {
    			var args = [this].concat(Array.prototype.slice.call(arguments));
    			return field[method.fn].apply(field, args);
    		});
    	});
    };

    /**
     * Adds a method to the underscoreMethods collection on the field's list,
     * with a path prefix to match this field's path and bound to the document
     */
    Field.prototype.underscoreMethod = function (path, fn) {
    	this.list.underscoreMethod(this.path + '.' + path, function () {
    		return fn.apply(this, arguments);
    	});
    };

    /**
     * Default method to format the field value for display
     * Overridden by some fieldType Classes
     *
     * @api public
     */
    Field.prototype.format = function (item) {
    	var value = item.get(this.path);
    	Iif (value === undefined) return '';
    	return value;
    };

    /**
     * Default method to detect whether the field has been modified in an item
     * Overridden by some fieldType Classes
     *
     * @api public
     */
    Field.prototype.isModified = function (item) {
    	return item.isModified(this.path);
    };

    /**
     * Checks whether a provided value for the field is in a valid format
     * Overridden by some fieldType Classes
     *
     * @api public
     */
    Field.prototype.validateInput = function (data, callback) {
    	utils.defer(callback, this.inputIsValid(data));
    };

    /**
     * Validates that a value for this field has been provided in a data object,
     * taking into account existing data in an item
     * Overridden by some fieldType Classes
     *
     * @api public
     */
    Field.prototype.validateRequiredInput = function (item, data, callback) {
    	utils.defer(callback, this.inputIsValid(data, true, item));
    };

    /**
     * Validates that a value for this field has been provided in a data object
     * Overridden by some fieldType Classes
     *
     * Not a reliable public API; use inputIsValid, which is async, instead.
     * This method has been deprecated.
     */
    Field.prototype.inputIsValid = function (data, required, item) {
    	Eif (!required) return true;
    	var value = this.getValueFromData(data);
    	if (value === undefined && item && item.get(this.path)) return true;
    	if (typeof data[this.path] === 'string') {
    		return (data[this.path].trim()) ? true : false;
    	} else {
    		return (data[this.path]) ? true : false;
    	}
    };

    /**
     * Updates the value for this field in the item from a data object
     * Overridden by some fieldType Classes
     *
     * @api public
     */
    Field.prototype.updateItem = function (item, data, callback) {
    	var value = this.getValueFromData(data);
    	// This is a deliberate type coercion so that numbers from forms play nice
    	Eif (value !== undefined && value != item.get(this.path)) { // eslint-disable-line eqeqeq
    		item.set(this.path, value);
    	}
    	process.nextTick(callback);
    };

    /**
     * Retrieves the value from an object, whether the path is nested or flattened
     *
     * @api public
     */
    Field.prototype.getValueFromData = function (data, subpath) {
    	return this._path.get(data, subpath);
    };