alchemymvc 1.3.22 → 1.4.0-alpha.2

package/lib/class/schema_client.js

@@ -4,7 +4,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
@@ -21,11 +21,11 @@ const Schema = Function.inherits(['Deck', 'Alchemy.Client.Base'], 'Alchemy.Clien
 /**
  * Add a relation creator method
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.4
  * @version  1.3.4
  *
- * @param    {String}   relation_type
+ * @param    {string}   relation_type
  */
 Schema.setStatic(function addRelationCreator(relation_type, relation_config) {
 
@@ -39,13 +39,13 @@ Schema.setStatic(function addRelationCreator(relation_type, relation_config) {
 /**
  * Is the given variable a schema?
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
  * @param    {Mixed}   value
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Schema.setStatic(function isSchema(value) {
 
@@ -65,7 +65,7 @@ Schema.setStatic(function isSchema(value) {
  *
  * @TODO: Make Client.Schema & Schema use the same implementation
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.3
  *
@@ -107,7 +107,7 @@ Schema.setDeprecatedProperty('hasBehaviours', 'has_behaviours');
 /**
  * Set a reference to itself
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
@@ -121,7 +121,7 @@ Schema.setProperty(function schema() {
  * Set a reference to the root schema
  * (For nested schemas)
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
@@ -139,11 +139,11 @@ Schema.setProperty(function root_schema() {
 /**
  * Amount of fields in this schema
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.3
  * @version  1.1.3
  *
- * @type     {Number}
+ * @type     {number}
  */
 Schema.setProperty(function field_count() {
 
@@ -159,7 +159,7 @@ Schema.setProperty(function field_count() {
  * @since    1.3.0
  * @version  1.3.0
  *
- * @type     {Boolean}
+ * @type     {boolean}
  */
 Schema.setProperty(function has_translatable_fields() {
 	return this.has_translations;
@@ -168,7 +168,7 @@ Schema.setProperty(function has_translatable_fields() {
 /**
  * Add the relationships
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.4
  */
@@ -181,12 +181,12 @@ Schema.addRelationCreator('HasOneChild',         {internal: false, singular: tru
 /**
  * Browser-side association adder
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.4
  * @version  1.3.21
  *
- * @param    {String}   alias
- * @param    {String}   modelname
+ * @param    {string}   alias
+ * @param    {string}   modelname
  * @param    {Object}   options
  *
  * @return   {Object}
@@ -237,13 +237,13 @@ Schema.setMethod(function addAssociation(relation_type, relation_config, alias,
 /**
  * Conform association arguments
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.21
+ * @version  1.4.0
  *
- * @param    {Boolean}  is_internal      Is this internal (A remote record's id is stored inside this record)
- * @param    {String}   alias
- * @param    {String}   model_name
+ * @param    {boolean}  is_internal      Is this internal (A remote record's id is stored inside this record)
+ * @param    {string}   alias
+ * @param    {string}   model_name
  * @param    {Object}   options
  */
 Schema.setMethod(function getAssociationArguments(is_internal, alias, model_name, options) {
@@ -257,6 +257,7 @@ Schema.setMethod(function getAssociationArguments(is_internal, alias, model_name
 
 	if (typeof model_name === 'undefined') {
 		model_name = alias;
+		alias = null;
 	}
 
 	let local_key   = options.local_key || options.localKey || false,
@@ -270,6 +271,16 @@ Schema.setMethod(function getAssociationArguments(is_internal, alias, model_name
 		throw new Error('Foreign key for ' + alias + ' association can not be an object');
 	}
 
+	// Get the actual model
+	let model = this.getModel(model_name);
+
+	// And get the correct model_name
+	model_name = model.model_name;
+
+	if (!alias) {
+		alias = model_name;
+	}
+
 	if (is_internal) {
 
 		if (!local_key) {
@@ -277,13 +288,11 @@ Schema.setMethod(function getAssociationArguments(is_internal, alias, model_name
 		}
 
 		if (!foreign_key) {
-			let model = this.getModel(model_name);
 			foreign_key = model.primary_key || '_id';
 		}
 	} else {
 
 		if (!local_key) {
-			let model = this.getModel(model_name);
 			local_key = model.primary_key || '_id';
 		}
 
@@ -350,7 +359,7 @@ Schema.setMethod(function clone() {
 /**
  * Dry the object
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.3.1
  *
@@ -413,7 +422,7 @@ Schema.setMethod(function toDry() {
 /**
  * Initialize some values
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.3.21
  */
@@ -463,11 +472,11 @@ Schema.setMethod(function init() {
 /**
  * Set the name of this schema
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
- * @param    {String}   name
+ * @param    {string}   name
  */
 Schema.setMethod(function setName(name) {
 	this.name = name;
@@ -476,7 +485,7 @@ Schema.setMethod(function setName(name) {
 /**
  * Set the parent schema
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.21
  *
@@ -495,11 +504,11 @@ Schema.setMethod(function setParent(schema) {
 /**
  * Set the model this schema can use
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.3
  *
- * @param    {String|Function|Object}   model
+ * @param    {string|Function|Object}   model
  */
 Schema.setMethod(function setModel(model) {
 
@@ -516,7 +525,7 @@ Schema.setMethod(function setModel(model) {
 	if (typeof model == 'string') {
 		path = model;
 	} else {
-		path = model.name;
+		path = model.model_name;
 
 		// See if this passed model is a constructor
 		if (model.staticChain) {
@@ -541,9 +550,10 @@ Schema.setMethod(function setModel(model) {
 		}
 	}
 
-	model_name = constructor.name;
+	model_name = constructor.model_name;
 	namespace = constructor.namespace;
 
+	this.model_class_name = constructor.name;
 	this.model_name = model_name;
 	this.model_class = constructor;
 	this.namespace = namespace;
@@ -560,7 +570,7 @@ Schema.setMethod(function setModel(model) {
 /**
  * Simplify the object for Hawkejs
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
@@ -664,12 +674,12 @@ Schema.setMethod(function getPrivateFields() {
  * The value of these fields will be computed
  * when the document is saved or loaded.
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  *
- * @param    {String}   name
- * @param    {String}   type
+ * @param    {string}   name
+ * @param    {string}   type
  * @param    {Object}   options
  *
  * @return   {Alchemy.Field.Field}
@@ -713,12 +723,12 @@ Schema.setMethod(function addComputedField(name, type, options) {
 /**
  * Add a field to this schema
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.21
  *
- * @param    {String}   name
- * @param    {String}   type
+ * @param    {string}   name
+ * @param    {string}   type
  * @param    {Object}   options
  *
  * @return   {Alchemy.Field.Field}
@@ -775,8 +785,8 @@ Schema.setMethod(function addField(name, type, options) {
 	if (options.constraints) {
 		let required_fields = options.required_fields,
 		    optional_fields = options.optional_fields,
-		    value,
-		    key;
+		    constraints = options.constraints = Classes.Alchemy.Criteria.Criteria.cast(options.constraints),
+		    target_path;
 
 		if (!required_fields) {
 			required_fields = [];
@@ -790,13 +800,9 @@ Schema.setMethod(function addField(name, type, options) {
 			optional_fields = optional_fields.slice(0);
 		}
 
-		for (key in options.constraints) {
-			value = options.constraints[key];
-
-			if (value && typeof value == 'object') {
-				if (value instanceof Classes.Alchemy.PathEvaluator) {
-					required_fields.push(value);
-				}
+		for (target_path of constraints.getAllExpressionTargetPaths()) {
+			if (!required_fields.includes(target_path)) {
+				required_fields.push(target_path);
 			}
 		}
 
@@ -837,11 +843,11 @@ Schema.setMethod(function addField(name, type, options) {
 /**
  * Add a rule to this schema
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.21
  *
- * @param    {String}   rule_name
+ * @param    {string}   rule_name
  * @param    {Object}   options
  */
 Schema.setMethod(function addRule(rule_name, options) {
@@ -868,12 +874,12 @@ Schema.setMethod(function addRule(rule_name, options) {
 /**
  * Get the path to this schema
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.4.0
  *
- * @param    {String}   extra            Extra to append to the path (like field name)
- * @param    {Boolean}  with_top_schema  Add top schema name, defaults to true
+ * @param    {string}   extra            Extra to append to the path (like field name)
+ * @param    {boolean}  with_top_schema  Add top schema name, defaults to true
  */
 Schema.setMethod(function getPath(extra, with_top_schema) {
 
@@ -913,11 +919,11 @@ Schema.setMethod(function getPath(extra, with_top_schema) {
 /**
  * Get a field
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.0
  *
- * @param    {String}   name
+ * @param    {string}   name
  *
  * @return   {FieldType}
  */
@@ -933,11 +939,11 @@ Schema.setMethod(function getField(name) {
 /**
  * Get an association by name
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  *
- * @param    {String}   name
+ * @param    {string}   name
  *
  * @return   {Object}
  */
@@ -948,11 +954,11 @@ Schema.setMethod(function getAssociation(name) {
 /**
  * Get a field
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.2.21
  *
- * @param    {String|PathEvaluator}   name
+ * @param    {string|PathEvaluator}   name
  *
  * @return   {FieldType[]}
  */
@@ -1020,11 +1026,11 @@ Schema.setMethod(function getFieldChain(name) {
 /**
  * Get all field names
  *
- * @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}
  */
 Schema.setMethod(function getFieldNames() {
 	return Object.keys(this.dict);
@@ -1033,11 +1039,11 @@ Schema.setMethod(function getFieldNames() {
 /**
  * Add an index
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.17
+ * @version  1.4.0
  *
- * @param    {String|FieldType}   _field
+ * @param    {string|FieldType}   _field
  * @param    {Object}             options
  *
  * @return   {FieldType}
@@ -1067,13 +1073,33 @@ Schema.setMethod(function addIndex(_field, _options) {
 	// Set the default options
 	options = Object.assign({}, this.indexOptions, options);
 
-	if (options.name == null) {
-		options.name = field.name;
+	const setIndexName = () => {
 
-		if (options.unique) {
-			options.name += '_uq';
+		if (options.name) {
+			return;
 		}
-	}
+
+		if (!this.model_name) {
+			return;
+		}
+
+		if (options.name == null) {
+			options.name = field.path;
+
+			if (options.unique) {
+				options.name += '_uq';
+			}
+		}
+
+		if (this.indexes[options.name] == null) {
+			// Create the index group if it doesn't exist yet.
+			// The first time it's called will define the group options.
+			this.indexes[options.name] = {
+				fields: {},
+				options: options
+			};
+		}
+	};
 
 	if (typeof options.order == 'number') {
 		if (options.order == 'asc') {
@@ -1083,15 +1109,6 @@ Schema.setMethod(function addIndex(_field, _options) {
 		}
 	}
 
-	if (this.indexes[options.name] == null) {
-		// Create the index group if it doesn't exist yet.
-		// The first time it's called will define the group options.
-		this.indexes[options.name] = {
-			fields: {},
-			options: options
-		};
-	}
-
 	// Even if an index is unique,
 	// it needs the 'alternate' property in order to be used
 	// as an alternate method of updating without _id
@@ -1099,6 +1116,9 @@ Schema.setMethod(function addIndex(_field, _options) {
 		this.has_alternates++;
 	}
 
+	// Try to set the index name now, if possible
+	setIndexName();
+
 	const that = this;
 
 	that.getDatasource().done(function gotDs(err, datasource) {
@@ -1117,6 +1137,9 @@ Schema.setMethod(function addIndex(_field, _options) {
 			return alchemy.printLog('error', ['Unable to ensure index on this datasource', options.name], {err: new Error()});
 		}
 
+		// Try to set the index name again, if it hasn't been done yet
+		setIndexName();
+
 		let path = field.path;
 
 		if (options.db_property) {
@@ -1139,7 +1162,7 @@ Schema.setMethod(function addIndex(_field, _options) {
 /**
  * Process the given object
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.0
  *
@@ -1209,7 +1232,7 @@ Schema.setMethod(function process(data, options) {
 /**
  * Get the datasource for this schema
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.3
  *
@@ -1241,14 +1264,14 @@ Schema.setMethod(function getDatasource() {
 /**
  * Get violations
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.4
  *
  * @param    {Document}   document   The main document
  * @param    {Object}     context    The parent object being handled
  *
- * @return   {Boolean|Violations}
+ * @return   {boolean|Violations}
  */
 Schema.setMethod(async function getViolations(document, context) {
 
@@ -1289,7 +1312,7 @@ Schema.setMethod(async function getViolations(document, context) {
 /**
  * Validate the given document, throws an error if it fails
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.1.0
  *