alchemymvc 1.3.21 → 1.4.0-alpha.1

package/lib/app/helper_field/local_date_time_field.js

@@ -3,7 +3,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.20
  * @version  1.3.20
  */
@@ -12,7 +12,7 @@ const LocalDateTime = Function.inherits('Alchemy.Field.LocalTemporal', 'LocalDat
 /**
  * Set the datatype name
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.20
  * @version  1.3.20
  */
@@ -21,15 +21,15 @@ LocalDateTime.setDatatype('datetime');
 /**
  * Cast the given value to this field's type
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.20
  * @version  1.3.20
  *
- * @param    {Mixed}   value
+ * @param    {*}   value
  *
  * @return   {Develry.LocalDateTime}
  */
-LocalDateTime.setMethod(function cast(value) {
+LocalDateTime.setCastFunction(function cast(value) {
 
 	if (value == null || value === '') {
 		return null;

package/lib/app/helper_field/local_time_field.js

@@ -3,7 +3,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.20
  * @version  1.3.20
  */
@@ -12,7 +12,7 @@ const LocalTime = Function.inherits('Alchemy.Field.LocalTemporal', 'LocalTime');
 /**
  * Set the datatype name
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.20
  * @version  1.3.20
  */
@@ -21,15 +21,15 @@ LocalTime.setDatatype('time');
 /**
  * Cast the given value to this field's type
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.20
  * @version  1.3.20
  *
- * @param    {Mixed}   value
+ * @param    {*}   value
  *
  * @return   {Develry.LocalTime}
  */
-LocalTime.setMethod(function cast(value) {
+LocalTime.setCastFunction(function cast(value) {
 
 	if (value == null || value === '') {
 		return null;

package/lib/app/helper_field/mixed_field.js

@@ -3,7 +3,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  */
@@ -12,7 +12,7 @@ const MixedField = Function.inherits('Alchemy.Field', 'Mixed');
 /**
  * Set the datatype name
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  */
@@ -21,7 +21,7 @@ MixedField.setDatatype('object');
 /**
  * This field value is self-contained
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  */
@@ -30,7 +30,7 @@ MixedField.setSelfContained(true);
 /**
  * Store objects as strings, if wanted
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  *
@@ -54,7 +54,7 @@ MixedField.setMethod(function _toDatasource(value, data, datasource, callback) {
 /**
  * Convert from database to app
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  *

package/lib/app/helper_field/object_field.js

@@ -3,7 +3,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  1.1.0
  */
@@ -14,7 +14,7 @@ var ObjectField = Function.inherits('Alchemy.Field', function Object(schema, nam
 /**
  * Set the datatype name
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  1.1.0
  */
@@ -23,7 +23,7 @@ ObjectField.setDatatype('object');
 /**
  * This field value is self-contained
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -32,17 +32,17 @@ ObjectField.setSelfContained(true);
 /**
  * Cast the given value to this field's type
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.5.0
- * @version  0.5.0
+ * @version  1.3.22
  *
  * @param    {Mixed}   value
  *
  * @return   {Object}
  */
-ObjectField.setMethod(function cast(value) {
+ObjectField.setCastFunction(function cast(value) {
 
-	if (typeof value == 'string') {
+	if (this.options.store_as_string && typeof value == 'string') {
 		return JSON.undry(value);
 	}
 
@@ -52,7 +52,7 @@ ObjectField.setMethod(function cast(value) {
 /**
  * Store objects as strings, if wanted
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.5.0
  * @version  1.1.0
  *

package/lib/app/helper_field/password_field.js

@@ -3,7 +3,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.2.3
  */
@@ -19,11 +19,11 @@ const bcrypt = alchemy.use('bcrypt'),
 /**
  * Make sure the password is hashed before storing it
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.4.0
  * @version  0.4.0
  *
- * @param    {String}      value        Value of field
+ * @param    {string}      value        Value of field
  * @param    {Object}      data         The data object containing `value`
  * @param    {Datasource}  datasource   The destination datasource
  */

package/lib/app/helper_field/regexp_field.js

@@ -3,18 +3,16 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.0
  */
-var RegExpField = Function.inherits('Alchemy.Field', function RegExp(schema, name, options) {
-	RegExp.super.call(this, schema, name, options);
-});
+const RegExpField = Function.inherits('Alchemy.Field', 'RegExp');
 
 /**
  * Set the datatype name
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.0
  */
@@ -23,7 +21,7 @@ RegExpField.setDatatype('regexp');
 /**
  * This field value is self-contained
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -32,15 +30,15 @@ RegExpField.setSelfContained(true);
 /**
  * Cast the given value to this field's type
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
  * @param    {Mixed}   value
  *
- * @return   {String}
+ * @return   {string}
  */
-RegExpField.setMethod(function cast(value) {
+RegExpField.setCastFunction(function cast(value) {
 
 	if (!(value instanceof RegExp)) {
 		value = RegExp.interpret(value);

package/lib/app/helper_field/schema_field.js

@@ -3,7 +3,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.16
  */
@@ -53,7 +53,7 @@ SchemaField.setDeprecatedProperty('fieldSchema', 'field_schema');
 /**
  * Schema fields are stored as objects
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -62,22 +62,22 @@ SchemaField.setDatatype('object');
 /**
  * Is this schema field always an array?
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.16
  * @version  1.3.16
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 SchemaField.setProperty('force_array_contents', false);
 
 /**
  * Get the subschema of this field
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
- * @return   {String}
+ * @return   {string}
  */
 SchemaField.setProperty(function root_model() {
 	return this.parent_schema.root_model || this.parent_schema.model_name;
@@ -86,11 +86,11 @@ SchemaField.setProperty(function root_model() {
 /**
  * Does this field need to be translated in some way?
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.4
  * @version  1.3.0
  *
- * @type     {Boolean}
+ * @type     {boolean}
  */
 SchemaField.setProperty(function requires_translating() {
 
@@ -108,12 +108,12 @@ SchemaField.setProperty(function requires_translating() {
 /**
  * Get the subschema of this field
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.21
  *
  * @param    {Object}   record      This *should* be the schema context (might not be the root)
- * @param    {String}   some_path   Some path to a field in the wanted schema
+ * @param    {string}   some_path   Some path to a field in the wanted schema
  *
  * @return   {Schema}
  */
@@ -133,14 +133,14 @@ SchemaField.setMethod(function getSubschema(record, some_path) {
 /**
  * Get the subschema of a given schema
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  *
  * @param    {Schema}   context_schema   The schema context (probably the schema this field is in)
  * @param    {Object}   record           This *should* be the schema context (might not be the root)
- * @param    {String}   some_path        Some path to a field in the wanted schema
- * @param    {String}   schema           The schema path to resolve
+ * @param    {string}   some_path        Some path to a field in the wanted schema
+ * @param    {string}   schema           The schema path to resolve
  *
  * @return   {Schema}
  */
@@ -209,12 +209,12 @@ SchemaField.setMethod(function resolveSchemaPath(context_schema, record, field_p
  * Get the subschema via an association
  * @TODO: Work in progress!
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.21
  *
  * @param    {Object}   record       This *should* be the schema context (might not be the root)
- * @param    {String}   path         The path inside the associated schema
+ * @param    {string}   path         The path inside the associated schema
  * @param    {Object}   association  The association object
  *
  * @return   {Schema}   Response might be a promise
@@ -252,7 +252,7 @@ SchemaField.setMethod(function getSubschemaFromAssociation(record, path, associa
 /**
  * Cast all the subschema values using their _toDatasource method
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.16
  *
@@ -284,7 +284,7 @@ SchemaField.setMethod(function _toDatasource(value, holder, datasource, callback
 /**
  * Cast all the subschema values using their _toDatasource method
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.1
  *
@@ -365,9 +365,9 @@ SchemaField.setMethod(function _toDatasourceFromValue(value, holder, datasource,
 /**
  * Turn datasource data into app data
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.16
+ * @version  1.4.0
  *
  * @param    {Mixed}      value
  * @param    {Function}   callback
@@ -388,28 +388,34 @@ SchemaField.setMethod(function _toApp(query, options, value, callback) {
 		});
 	}
 
-	Function.parallel(tasks, (err, result) => {
+	Pledge.Swift.all(tasks).done((err, result) => {
 
 		if (err) {
 			return callback(err);
 		}
 
-		callback(null, this.cast(result));
-	});
+		try {
+			result = this.cast(result)
+		} catch (err) {
+			callback(err);
+			return;
+		}
 
+		callback(null, result);
+	});
 });
 
 /**
  * Turn datasource data into app data
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.16
+ * @version  1.4.0
  *
  * @param    {Mixed}      value
  * @param    {Function}   callback
  */
-SchemaField.setMethod(function _toAppFromValue(query, options, value, callback) {
+SchemaField.setMethod(async function _toAppFromValue(query, options, value, callback) {
 
 	var that = this,
 	    recursive,
@@ -421,7 +427,11 @@ SchemaField.setMethod(function _toAppFromValue(query, options, value, callback)
 	recursive = options.recursive;
 
 	if (recursive == null) {
-		recursive = 1;
+		if (this.options?.recursive != null) {
+			recursive = this.options.recursive;
+		} else {
+			recursive = 1;
+		}
 	}
 
 	if (recursive && Blast.isBrowser) {
@@ -430,59 +440,6 @@ SchemaField.setMethod(function _toAppFromValue(query, options, value, callback)
 		recursive = 0;
 	}
 
-	// Get associated records if the subschema has associations defined
-	if (recursive && this.field_schema && !Object.isEmpty(this.field_schema.associations)) {
-
-		name = this.name + 'FieldModel';
-		Dummy = alchemy.getModel('Model', false);
-
-		Dummy = new Dummy({
-			root_model : this.root_model,
-			name       : name
-		});
-
-		item = {};
-
-		item[name] = value;
-
-		let sub_criteria = Dummy.find();
-
-		// Disable generating Document instances
-		// if the original find did the same
-		sub_criteria.setOption('document', options.document);
-		sub_criteria.setOption('original_query', query);
-		sub_criteria.setOption('_root_data', options._root_data);
-		sub_criteria.setOption('_parent_field', that);
-		sub_criteria.setOption('_parent_model', that.schema.model_name);
-		sub_criteria.setOption('recursive', recursive);
-
-		sub_criteria.setOption('associations', this.field_schema.associations);
-
-		// @todo: inherit other original find options?
-
-		Dummy.addAssociatedDataToRecord(sub_criteria, item, function gotAssociatedData(err, result) {
-
-				var key;
-
-				if (err) {
-					return callback(err);
-				}
-
-				for (key in result) {
-					if (key == name) {
-						continue;
-					}
-
-					value[key] = result[key];
-				}
-
-				callback(null, value);
-			}
-		);
-
-		return;
-	}
-
 	let record;
 
 	if (options.parent_value) {
@@ -532,14 +489,60 @@ SchemaField.setMethod(function _toAppFromValue(query, options, value, callback)
 			}
 		});
 
-		return Function.parallel(4, tasks, function convertedFields(err, result) {
+		value = await Function.parallel(4, tasks);
+	}
 
-			if (err) {
-				return callback(err);
-			}
+	// Get associated records if the subschema has associations defined
+	if (recursive && this.field_schema && !Object.isEmpty(this.field_schema.associations)) {
 
-			callback(null, that.castEntry(result));
+		name = this.name + 'FieldModel';
+		Dummy = alchemy.getModel('Model', false);
+
+		Dummy = new Dummy({
+			root_model : this.root_model,
+			name       : name
 		});
+
+		item = {};
+
+		item[name] = value;
+
+		let sub_criteria = Dummy.find();
+
+		// Disable generating Document instances
+		// if the original find did the same
+		sub_criteria.setOption('document', options.document);
+		sub_criteria.setOption('original_query', query);
+		sub_criteria.setOption('_root_data', options._root_data);
+		sub_criteria.setOption('_parent_field', that);
+		sub_criteria.setOption('_parent_model', that.schema.model_name);
+		sub_criteria.setOption('recursive', recursive);
+
+		sub_criteria.setOption('associations', this.field_schema.associations);
+
+		// @todo: inherit other original find options?
+
+		Dummy.addAssociatedDataToRecord(sub_criteria, item, function gotAssociatedData(err, result) {
+
+				var key;
+
+				if (err) {
+					return callback(err);
+				}
+
+				for (key in result) {
+					if (key == name) {
+						continue;
+					}
+
+					value[key] = result[key];
+				}
+
+				callback(null, value);
+			}
+		);
+
+		return;
 	}
 
 	callback(null, this.castEntry(value));
@@ -548,7 +551,7 @@ SchemaField.setMethod(function _toAppFromValue(query, options, value, callback)
 /**
  * Translate the given value
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.4
  * @version  1.3.0
  */
@@ -601,7 +604,7 @@ SchemaField.setMethod(function translateRecord(prefixes, record, allow_empty) {
 /**
  * Cast an entry
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.16
  * @version  1.3.16
  */
@@ -612,10 +615,10 @@ SchemaField.setMethod(function castEntry(value, to_datasource) {
 /**
  * Cast the value to a document
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.5
  * @version  1.1.5
  */
-SchemaField.setMethod(function cast(value, to_datasource) {
+SchemaField.setCastFunction(function cast(value, to_datasource) {
 	return value;
 });

package/lib/app/helper_field/settings_field.js

@@ -0,0 +1,92 @@
+/**
+ * A Settings field lets you add settings to something
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ */
+const Settings = Function.inherits('Alchemy.Field.Schema', function Settings(schema, name, options) {
+
+	if (!options?.setting_group) {
+		throw new Error('A settings field requires a `setting_group` option with');
+	}
+
+	// A custom schema should NOT be passed to this class, this class uses
+	// a fixed schema that should not be altered.
+	// But because that's exactly what happens when cloning (like preparing
+	// the data to be sent to Hawkejs) we have to allow it anyway
+	if (!options.schema) {
+		let settings_schema = alchemy.createSchema();
+
+		settings_schema.addField('setting_id', 'Enum', {
+			description: 'The setting id',
+			values     : options.setting_group.createEnumMap(),
+		});
+
+		settings_schema.addField('configuration', 'Schema', {
+			description: 'The actual configuration of the setting',
+			schema     : 'setting_id',
+		});
+		
+		options.schema = settings_schema;
+	}
+
+	Settings.super.call(this, schema, name, options);
+});
+
+/**
+ * Is this schema field always an array?
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @return   {Boolean}
+ */
+Settings.setProperty('force_array_contents', true);
+
+/**
+ * Cast the given value to this field's type
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {*}   value
+ *
+ * @return   {Settings}
+ */
+Settings.setCastFunction(function cast(value) {
+
+	let result = this.options.setting_group.generateValue();
+
+	if (value) {
+		result.setValueSilently(value);
+	}
+
+	return result;
+});
+
+/**
+ * Prepare the value of this field to be stored in the database
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {*}            value       The field's own value
+ * @param    {Object}       data        The main record
+ * @param    {Datasource}   datasource  The datasource instance
+ *
+ * @return   {*}
+ */
+Settings.setMethod(function _toDatasource(value, data, datasource, callback) {
+
+	if (value) {
+		value = value.toDatasourceArray();
+	}
+
+	_toDatasource.super.call(this, value, data, datasource, callback);
+});