alchemymvc 1.2.1 → 1.2.4

package/lib/app/helper_model/document.js

@@ -305,7 +305,7 @@ Document.setStatic(function getDocumentClass(model) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.0.0
- * @version  1.1.0
+ * @version  1.2.4
  *
  * @param    {Object}           obj
  * @param    {Boolean|String}   cloned
@@ -349,6 +349,25 @@ Document.setStatic(function unDry(obj, cloned) {
 		obj.$options.model = null;
 	}
 
+	if (Blast.isBrowser && obj.$options?.private_fields) {
+		let model = alchemy.getModel(obj.$model_name),
+		    field;
+		
+		for (field of obj.$options.private_fields) {
+
+			// @TODO: don't let documents undry before schema is ready?
+			if (!model.schema) {
+				continue;
+			}
+
+			if (model.schema.has(field.name)) {
+				continue;
+			}
+
+			model.schema.addField(field.name, field.constructor.type_name, field.options);
+		}
+	}
+
 	DocClass.call(result, obj.$record, obj.$options);
 
 	if (cloned || Blast.isNode || obj[Blast.Classes.IndexedDb.from_cache_symbol]) {
@@ -621,7 +640,7 @@ Document.setMethod(function toDry() {
  *
  * @author   Jelle De Loecker <jelle@develry.be>
  * @since    1.0.4
- * @version  1.1.0
+ * @version  1.2.4
  *
  * @param    {Object}   record
  * @param    {Object}   options
@@ -662,13 +681,32 @@ Document.setMethod(function setDataRecord(record, options) {
 	this.$record = record;
 
 	if (Blast.isNode && this.constructor.namespace.indexOf('Alchemy.Document') == -1) {
-		let field,
+		let delete_field = false,
+		    added_private_field_info = false,
+		    field,
 		    key;
 
 		for (key in this.$main) {
 			field = this.$model.schema.get(key);
 
-			if (!field || field.is_private) {
+			if (!field) {
+				delete_field = true;
+			} else if (field.is_private) {
+				delete_field = true;
+
+				if (options.keep_private_fields) {
+					delete_field = false;
+
+					if (!added_private_field_info) {
+						added_private_field_info = true;
+
+						let fields = this.$model.schema.getPrivateFields();
+						options.private_fields = JSON.clone(fields, 'toHawkejs');
+					}
+				}
+			}
+
+			if (delete_field) {
 				delete this.$main[key];
 			}
 		}

package/lib/app/helper_model/document_list.js

@@ -143,14 +143,37 @@ DocumentList.setMethod(function createIterator() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.0.0
- * @version  1.1.3
+ * @version  1.2.4
  *
  * @return   {Object}
  */
 DocumentList.setMethod(function toDry() {
+
+	let options;
+
+	if (this.options) {
+		let val,
+		    key;
+
+		options = {};
+
+		for (key in this.options) {
+			val = this.options[key];
+
+			if (key == 'options') {
+				val = Object.assign({}, val);
+				val.assoc_cache = undefined;
+			} else if (key == 'assoc_cache') {
+				continue;
+			}
+
+			options[key] = val;
+		}
+	}
+
 	return {
 		value: {
-			options    : this.options,
+			options    : options,
 			records    : this.records,
 			available  : this.available,
 		}

package/lib/app/helper_model/field_config.js

@@ -29,6 +29,9 @@ const FieldConfig = Fn.inherits('Alchemy.Base', 'Alchemy.Criteria', function Fie
 	// The association this belongs to
 	this.association = null;
 
+	// The main model this field is in
+	this.model = null;
+
 	this.options = options || {};
 
 	if (path) {
@@ -41,15 +44,24 @@ const FieldConfig = Fn.inherits('Alchemy.Base', 'Alchemy.Criteria', function Fie
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.1.3
- * @version  1.1.3
+ * @version  1.2.3
  *
  * @param    {Object}   obj
  *
  * @return   {Alchemy.Form.FieldConfig}
  */
 FieldConfig.setStatic(function unDry(obj) {
-	let set = new FieldConfig(obj.path, obj.options);
-	return set;
+	let result = new FieldConfig(obj.path, obj.options);
+
+	if (obj.association) {
+		result.association = obj.association;
+	}
+
+	if (obj.model) {
+		result.model = obj.model;
+	}
+
+	return result;
 });
 
 /**
@@ -72,6 +84,94 @@ FieldConfig.setProperty(function title() {
 	return title;
 });
 
+/**
+ * Set the main model context this field is used for
+ * (Actual field can be in an association of this model)
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.2
+ * @version  1.2.2
+ *
+ * @param    {String|Model}   model
+ */
+FieldConfig.setMethod(function setContextModel(model) {
+
+	if (typeof model == 'string') {
+		this.model = model;
+		this._model = alchemy.getModel(model);
+	} else {
+		this._model = model;
+		this.model = model.model_name;
+	}
+});
+
+/**
+ * Get the context model this field is used for
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.2
+ * @version  1.2.2
+ */
+FieldConfig.setMethod(function getContextModel() {
+
+	if (this._model) {
+		return this._model;
+	}
+
+	if (!this.model) {
+		return;
+	}
+
+	this._model = alchemy.getModel(this.model);
+	return this._model;
+});
+
+/**
+ * Get the actual model this field is in
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.2
+ * @version  1.2.2
+ */
+FieldConfig.setMethod(function getModel() {
+
+	let model = this.getContextModel();
+
+	if (!model) {
+		return;
+	}
+
+	if (this.association) {
+		let config = model.getAssociation(this.association);
+
+		if (config) {
+			model = alchemy.getModel(config.modelName);
+		} else {
+			model = null;
+		}
+	}
+
+	return model;
+});
+
+/**
+ * Get the field definition
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.2
+ * @version  1.2.2
+ */
+FieldConfig.setMethod(function getFieldDefinition() {
+
+	let model = this.getModel();
+
+	if (!model) {
+		return;
+	}
+
+	return model.getField(this.local_path);
+});
+
 /**
  * Return an object for json-drying this list
  *
@@ -103,6 +203,7 @@ FieldConfig.setMethod(function toJSON() {
 		local_path  : this.local_path,
 		association : this.association,
 		options     : this.options,
+		model       : this.model,
 	};
 });
 

package/lib/app/helper_model/field_set.js

@@ -143,6 +143,28 @@ FieldSet.setMethod(function toJSON() {
 	return result;
 });
 
+/**
+ * Get an instance of the model
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.2
+ * @version  1.2.2
+ *
+ * @return   {Model}
+ */
+FieldSet.setMethod(function getModel() {
+
+	if (!this.model) {
+		return;
+	}
+
+	if (!this._model) {
+		this._model = alchemy.getModel(this.model);
+	}
+
+	return this._model;
+});
+
 /**
  * Iterator method
  *
@@ -165,7 +187,7 @@ FieldSet.setMethod(Symbol.iterator, function* iterate() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.1.3
- * @version  1.1.3
+ * @version  1.2.2
  *
  * @param    {String}   name      The name of the field to add
  * @param    {Object}   options
@@ -176,6 +198,10 @@ FieldSet.setMethod(function addField(name, options) {
 
 	let config = new Classes.Alchemy.Criteria.FieldConfig(name, options);
 
+	if (this.model && !config.getContextModel()) {
+		config.setContextModel(this.model);
+	}
+
 	this.fields.set(name, config);
 
 	return config;

package/lib/app/helper_model/model.js

@@ -1103,13 +1103,20 @@ Model.setMethod(function addAssociatedDataToRecord(criteria, item, callback) {
 
 		aliases[alias] = function aliasRecordTask(nextAlias) {
 
-			var key;
+			let pledge,
+			    key;
 
 			if (options.create_references !== false) {
 				key = alchemy.checksum(assoc_crit);
 
-				if (key != null && options.assoc_cache[key]) {
-					return nextAlias(null, options.assoc_cache[key]);
+				if (key != null) {
+					if (options.assoc_cache[key]) {
+						Pledge.done(options.assoc_cache[key], nextAlias);
+						return;
+					} else {
+						pledge = new Pledge();
+						options.assoc_cache[key] = pledge;
+					}
 				}
 			}
 
@@ -1125,6 +1132,11 @@ Model.setMethod(function addAssociatedDataToRecord(criteria, item, callback) {
 				}
 
 				if (err != null) {
+
+					if (pledge) {
+						pledge.reject(err);
+					}
+
 					return nextAlias(err);
 				}
 
@@ -1140,6 +1152,10 @@ Model.setMethod(function addAssociatedDataToRecord(criteria, item, callback) {
 
 				if (key) {
 					options.assoc_cache[key] = result;
+
+					if (pledge) {
+						pledge.resolve(result);
+					}
 				}
 
 				nextAlias(null, result);

package/lib/app/helper_model/remote_data_provider.js

@@ -0,0 +1,35 @@
+/**
+ * The Remote DataProvider class
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.2
+ * @version  1.2.2
+ */
+const RemoteDataProvider = Function.inherits('Alchemy.DataProvider', 'Remote');
+
+/**
+ * The url to load
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.2.2
+ * @version  1.2.2
+ */
+RemoteDataProvider.addConfig('source');
+
+/**
+ * Get all the data
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.2.2
+ * @version  1.2.2
+ */
+RemoteDataProvider.setMethod(async function getAll() {
+
+	if (!this.source) {
+		return [];
+	}
+
+	let result = await Blast.fetch(this.source);
+
+	return result;
+});

package/lib/bootstrap.js

@@ -3,6 +3,22 @@
 var libpath = require('path'),
     starting;
 
+/**
+ * Calling dynamic `import()` from certain places in the codebase actually
+ * causes segfaults. This is a workaround for that.
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.2
+ * @version  1.2.2
+ *
+ * @param    {String}   path
+ *
+ * @return   {Promise}
+ */
+global.doImport = function doImport(path) {
+	return import(path);
+};
+
 /**
  * Extend prototypes
  */

package/lib/class/document.js

@@ -386,7 +386,7 @@ Document.setMethod(function toDry() {
  *
  * @author   Jelle De Loecker <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.2.4
  *
  * @param    {WeakMap}   wm
  *
@@ -412,7 +412,10 @@ Document.setMethod(function toHawkejs(wm) {
 	// Sometimes we get an EMPTY $record value,
 	// this is probably because it's already in the process of being clones
 	if (!Object.isEmpty(record)) {
-		result.setDataRecord(record);
+		// Get clean options
+		let options = JSON.clone(this.getCleanOptions(), 'toHawkejs', wm);
+
+		result.setDataRecord(record, options);
 	} else {
 		record.$record = record;
 	}
@@ -425,6 +428,24 @@ Document.setMethod(function toHawkejs(wm) {
 	return result;
 });
 
+/**
+ * Keep private fields when sending to browser
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.2.4
+ * @version  1.2.4
+ */
+Document.setMethod(function keepPrivateFields(value) {
+
+	if (arguments.length == 0) {
+		value = true;
+	} else {
+		value = !!value;
+	}
+
+	this.$options.keep_private_fields = value;
+});
+
 /**
  * Return the basic record for JSON
  *
@@ -536,27 +557,24 @@ Document.setMethod(function remove(callback) {
 /**
  * Add associated data to this record
  *
- * @author   Jelle De Loecker <jelle@develry.be>
- * @since    0.2.0
- * @version  1.1.0
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.2.3
+ * @version  1.2.3
  *
- * @param    {Criteria} criteria
- * @param    {Function} callback
+ * @param    {Criteria|String} criteria
  *
- * @return   {Pledge}
+ * @return   {Criteria}
  */
-Document.setMethod(['populate', 'addAssociatedData'], function addAssociatedData(criteria, callback) {
+Document.setMethod(function preparePopulationCriteria(criteria) {
 
-	var that  = this,
+	let type = typeof criteria,
 	    model = this.$model,
-	    type  = typeof criteria,
 	    selects;
 
 	if (type == 'string') {
 		selects = [criteria];
 		criteria = {};
 	} else if (type == 'function') {
-		callback = criteria;
 		criteria = {};
 	} else if (Array.isArray(criteria)) {
 		selects = criteria;
@@ -583,7 +601,31 @@ Document.setMethod(['populate', 'addAssociatedData'], function addAssociatedData
 		}
 	}
 
-	return model.addAssociatedDataToRecord(criteria, this.$record, callback);
+	return criteria;
+});
+
+/**
+ * Add associated data to this record
+ *
+ * @author   Jelle De Loecker <jelle@develry.be>
+ * @since    0.2.0
+ * @version  1.2.3
+ *
+ * @param    {Criteria} criteria
+ * @param    {Function} callback
+ *
+ * @return   {Pledge}
+ */
+Document.setMethod(['populate', 'addAssociatedData'], function addAssociatedData(criteria, callback) {
+
+	if (typeof criteria == 'function') {
+		callback = criteria;
+		criteria = null;
+	}
+
+	criteria = this.preparePopulationCriteria(criteria);
+
+	return this.$model.addAssociatedDataToRecord(criteria, this.$record, callback);
 });
 
 /**

package/lib/class/document_list.js

@@ -63,13 +63,23 @@ DocumentList.setMethod(function clone() {
  *
  * @author   Jelle De Loecker <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.2.3
  *
  * @param    {Criteria}   criteria
  *
  * @return   {Pledge}
  */
 DocumentList.setMethod(['populate', 'addAssociatedData'], function addAssociatedData(criteria) {
+
+	if (!this.records?.length) {
+		return;
+	}
+
+	let doc = this.records[0];
+
+	// Use the first doc to prepare the population criteria
+	criteria = doc.preparePopulationCriteria(criteria);
+
 	return Function.forEach.parallel(this.records, function eachDoc(doc, key, next) {
 		doc.populate(criteria).done(next);
 	});
@@ -105,4 +115,26 @@ DocumentList.setMethod(function findNextBatch(callback) {
 	}
 
 	this.options.model.find('all', options, callback);
+});
+
+/**
+ * Keep private fields when sending to browser
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.2.4
+ * @version  1.2.4
+ */
+DocumentList.setMethod(function keepPrivateFields(value) {
+
+	if (arguments.length == 0) {
+		value = true;
+	} else {
+		value = !!value;
+	}
+
+	let record;
+
+	for (record of this) {
+		record.keepPrivateFields(value);
+	}
 });

package/lib/class/element.js

@@ -5,9 +5,7 @@
  * @since    1.0.0
  * @version  1.0.0
  */
-var Element = Function.inherits('Hawkejs.Element', 'Alchemy.Element', function Element() {
-	return Element.super.call(this);
-});
+const Element = Function.inherits('Hawkejs.Element', 'Alchemy.Element', 'Element');
 
 /**
  * The default element prefix (when element contains no hyphen) is "al"
@@ -111,4 +109,20 @@ Element.setMethod(function getModel(model_name, options) {
 	this._model_instances[model_name] = instance;
 
 	return instance;
+});
+
+/**
+ * Default translation implementation
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.4
+ * @version  1.2.4
+ *
+ * @param   {String}   key
+ * @param   {Object}   parameters
+ *
+ * @return  {String}
+ */
+Element.setMethod(function __(key, parameters) {
+	return key;
 });

package/lib/class/field.js

@@ -105,12 +105,17 @@ Field.setStatic(function createPathEvaluator(path) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.0.0
- * @version  1.0.0
+ * @version  1.2.4
  *
  * @type     {Boolean}
  */
 Field.setProperty(function is_private() {
-	return !!this.options.is_private;
+
+	if (this.options.is_private || this.options.private) {
+		return true;
+	}
+
+	return false;
 });
 
 /**

package/lib/class/model.js

@@ -362,7 +362,7 @@ Model.setStatic(function checkPathValue(value, name, field_name, conduit) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.0.7
+ * @version  1.2.4
  *
  * @return   {Alchemy.Field}
  */
@@ -380,12 +380,10 @@ Model.setStatic(function addField(name, type, options) {
 		// Add it to the Document class
 		this.Document.setFieldGetter(name);
 
-		// Add the field to the client document too, if it's not private
-		if (!field.is_private) {
-			// False means it should not be set on the server implementation
-			// (because that's where it's coming from)
-			this.ClientDocument.setFieldGetter(name, null, null, false);
-		}
+		// False means it should not be set on the server implementation
+		// (because that's where it's coming from)
+		// Yes, this also sets private fields on the server-side client document.
+		this.ClientDocument.setFieldGetter(name, null, null, false);
 	}
 
 	return field;
@@ -409,18 +407,16 @@ Model.setStatic(function addBehaviour(behaviour_name, options) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  0.2.0
+ * @version  1.2.4
  */
 Model.setStatic(function addAssociation(type, alias, model_name, options) {
 	var data = this.schema.addAssociation(type, alias, model_name, options);
 	this.Document.setAliasGetter(data.alias);
 
-	// Add the alias to the client document too, if it's not private
-	if (!options || !options.is_private) {
-		// False means it should not be set on the server implementation
-		// (because that's where it's coming from)
-		this.ClientDocument.setAliasGetter(name);
-	}
+	// False means it should not be set on the server implementation
+	// (because that's where it's coming from)
+	// Yes, this also sets private fields on the server-side client document.
+	this.ClientDocument.setAliasGetter(name);
 });
 
 /**