alchemymvc 1.3.21 → 1.4.0-alpha.1

package/lib/app/helper_model/data_provider.js

@@ -1,7 +1,7 @@
 /**
  * The DataProvider class
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.2.2
  * @version  1.2.2
  */
@@ -17,7 +17,7 @@ const DataProvider = Function.inherits('Alchemy.Base', 'Alchemy.DataProvider', f
  * @version  1.2.2
  *
  * @param    {Object}           obj
- * @param    {Boolean|String}   cloned
+ * @param    {boolean|string}   cloned
  *
  * @return   {DataProvider}
  */

package/lib/app/helper_model/document.js

@@ -8,10 +8,11 @@ if (Blast.isBrowser) {
 	Blast.once('hawkejs_init', function gotScene(hawkejs, variables, settings, renderer) {
 
 		let DocClass,
-		    config;
+		    config,
+		    key;
 		
 		for (config of hawkejs.scene.exposed.model_info) {
-			DocClass = Document.getDocumentClass(config.name);
+			DocClass = Document.getDocumentClass(config.model_name);
 
 			for (key in config.schema.dict) {
 				DocClass.setFieldGetter(key);
@@ -30,7 +31,7 @@ if (Blast.isBrowser) {
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.6
  *
@@ -44,14 +45,14 @@ var Document = Function.inherits('Alchemy.Client.Base', 'Alchemy.Client.Document
 /**
  * Set a property
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  *
- * @param    {String}     key        Name of the property
+ * @param    {string}     key        Name of the property
  * @param    {Function}   getter     Optional getter function
  * @param    {Function}   setter     Optional setter function
- * @param    {Boolean}    on_server  Also set on the server implementation
+ * @param    {boolean}    on_server  Also set on the server implementation
  */
 Document.setStatic(function setProperty(key, getter, setter, on_server) {
 
@@ -91,13 +92,13 @@ Document.setStatic(function setProperty(key, getter, setter, on_server) {
 /**
  * Set a method
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  *
- * @param    {String}     key        Name of the property
+ * @param    {string}     key        Name of the property
  * @param    {Function}   method     The method to set
- * @param    {Boolean}    on_server  Also set on the server implementation
+ * @param    {boolean}    on_server  Also set on the server implementation
  */
 Document.setStatic(function setMethod(key, method, on_server) {
 
@@ -138,8 +139,8 @@ Document.setStatic(function setMethod(key, method, on_server) {
  * @since    1.3.21
  * @version  1.3.21
  *
- * @param    {String}     name       Name of the property
- * @param    {Boolean}    on_server  Also set on the server implementation
+ * @param    {string}     name       Name of the property
+ * @param    {boolean}    on_server  Also set on the server implementation
  */
 Document.setStatic(function setComputedFieldGetter(name, on_server) {
 	this.setProperty(name, function getComputedFieldValue() {
@@ -160,14 +161,14 @@ Document.setStatic(function setComputedFieldGetter(name, on_server) {
 /**
  * Set a getter for this field
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.4
  *
- * @param    {String}     name     Name of the property
+ * @param    {string}     name     Name of the property
  * @param    {Function}   getter   Optional getter function
  * @param    {Function}   setter   Optional setter function
- * @param    {Boolean}    on_server  Also set on the server implementation
+ * @param    {boolean}    on_server  Also set on the server implementation
  */
 Document.setStatic(function setFieldGetter(name, getter, setter, on_server) {
 
@@ -192,11 +193,11 @@ Document.setStatic(function setFieldGetter(name, getter, setter, on_server) {
 /**
  * Set the getter for an alias
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  *
- * @param    {String}   name
+ * @param    {string}   name
  */
 Document.setStatic(function setAliasGetter(name) {
 
@@ -224,11 +225,11 @@ Document.setStatic(function setAliasGetter(name) {
 /**
  * Find class for JSON-Dry
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.6
  * @version  1.1.0
  *
- * @param    {String}   class_name
+ * @param    {string}   class_name
  */
 Document.setStatic(function getClassForUndry(class_name) {
 	return this.getDocumentClass(class_name);
@@ -237,44 +238,54 @@ Document.setStatic(function getClassForUndry(class_name) {
 /**
  * Create document class for specific model
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
- * @version  1.3.1
+ * @version  1.4.0
  *
- * @param    {Object|String}   model
+ * @param    {Function|Object|string}   model_param
  */
-Document.setStatic(function getDocumentClass(model) {
+Document.setStatic(function getDocumentClass(model_param) {
 
-	if (!model) {
+	if (!model_param) {
 		throw new Error('Can not get Hawkejs.Document class for non-existing model');
 	}
 
-	let model_name;
+	let model = typeof model_param == 'function' ? model_param : alchemy.getModel(model_param, false);
 
-	if (typeof model == 'function') {
-		model_name = model.name;
-	} else if (typeof model == 'string') {
-		model_name = model;
-	} else {
-		model_name = model.model_name;
+	if (!model) {
+		throw new Error('There is no model named "' + model_param + '"');
+	}
+
+	if (model.is_namespace) {
+		return;
 	}
 
-	// Construct the name of the document class
-	let document_name = model_name;
+	let model_name = model.model_name;
 
-	if (class_cache.has(document_name)) {
-		return class_cache.get(document_name);
+	if (class_cache.has(model_name)) {
+		return class_cache.get(model_name);
 	}
 
+	// Construct the name of the document class constructor
+	let document_name = model.name;
+
 	// Construct the path to this class
-	let doc_path = 'Alchemy.Client.Document.' + document_name;
+	let target_ns = 'Alchemy.Client.Document';
+	let doc_path = target_ns;
+
+	if (model.model_namespace) {
+		doc_path += '.' + model.model_namespace;
+		target_ns += '.' + model.model_namespace;
+	}
+
+	doc_path += '.' + document_name;
 
 	// Get the class
 	let DocClass = Object.path(Blast.Classes, doc_path);
 
 	if (DocClass == null) {
 		let doc_constructor = Function.create(document_name, function DocumentConstructor(record, options) {
-			DocumentConstructor.wrapper.super.call(this, record, options);
+			DocumentConstructor.super.call(this, record, options);
 		});
 
 		let parent,
@@ -310,7 +321,7 @@ Document.setStatic(function getDocumentClass(model) {
 			parent_path += '.' + parent;
 		}
 
-		DocClass = Function.inherits(parent_path, doc_constructor);
+		DocClass = Function.inherits(parent_path, target_ns, doc_constructor);
 
 		DocClass.setProperty('$model_name', model_name, null, false);
 
@@ -329,12 +340,12 @@ Document.setStatic(function getDocumentClass(model) {
 /**
  * unDry an object
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.2.5
  *
  * @param    {Object}           obj
- * @param    {Boolean|String}   cloned
+ * @param    {boolean|string}   cloned
  *
  * @return   {Document}
  */
@@ -430,13 +441,13 @@ Document.setStatic(function unDry(obj, cloned) {
 /**
  * Is the given argument a Document?
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.0.5
  *
  * @param    {Object}     obj
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Document.setStatic(function isDocument(obj) {
 
@@ -459,7 +470,7 @@ Document.setStatic(function isDocument(obj) {
 /**
  * Get the model instance
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.1.3
  */
@@ -475,7 +486,7 @@ Document.setProperty(function $model() {
 /**
  * Get the primary key value
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -498,7 +509,7 @@ Document.setProperty(function $pk() {
 /**
  * Set some properties to null
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -511,7 +522,7 @@ Document.setProperty('$record', null);
  * This will be used when comparing 2 documents.
  * You normally don't need to access this.
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
  * @version  1.0.4
  */
@@ -528,7 +539,7 @@ Document.setProperty(function $attributes() {
  * Extra values that will also be sent to the client.
  * These values won't be used when comparing 2 documents
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -544,11 +555,11 @@ Document.setProperty(function $hold() {
 /**
  * Get the $model_alias name
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @type     {String}
+ * @type     {string}
  */
 Document.setProperty(function $model_alias() {
 
@@ -564,7 +575,7 @@ Document.setProperty(function $model_alias() {
 /**
  * Get the $main data
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
@@ -596,11 +607,11 @@ Document.setProperty(function $main() {
 /**
  * Is this a new & unsaved record?
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.6
  * @version  1.1.0
  *
- * @param    {Boolean}
+ * @param    {boolean}
  */
 Document.setProperty(function is_new_record() {
 
@@ -618,13 +629,13 @@ Document.setProperty(function is_new_record() {
 /**
  * Compare to another object
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
  * @version  1.0.4
  *
  * @param    {Object}   other
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Document.setMethod(Blast.alikeSymbol, function alike(other, seen) {
 
@@ -642,7 +653,7 @@ Document.setMethod(Blast.alikeSymbol, function alike(other, seen) {
 /**
  * Return an object for json-drying this document
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.1.0
  *
@@ -665,11 +676,11 @@ Document.setMethod(function toDry() {
 /**
  * Get the displaytitle of this document, or null
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.13
  * @version  1.3.14
  *
- * @return   {String}
+ * @return   {string}
  */
 Document.setMethod(function getDisplayTitleOrNull() {
 
@@ -683,11 +694,11 @@ Document.setMethod(function getDisplayTitleOrNull() {
 /**
  * Get the displaytitle of this document
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.13
  * @version  1.3.14
  *
- * @return   {String}
+ * @return   {string}
  */
 Document.setMethod(function getDisplayTitle() {
 
@@ -796,12 +807,12 @@ Document.setMethod(function setDataRecord(record, options) {
 /**
  * Get the translated document for the given prefix with only the given field
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.10
  * @version  1.3.10
  *
- * @param    {String}   field_name
- * @param    {String}   prefix
+ * @param    {string}   field_name
+ * @param    {string}   prefix
  */
 Document.setMethod(async function getTranslatedDocumentOfPrefix(field_name, prefix) {
 
@@ -821,11 +832,11 @@ Document.setMethod(async function getTranslatedDocumentOfPrefix(field_name, pref
  * Get the translated value of a certain field.
  * If this document has already been translated, a new instance will be queried
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.10
  *
- * @param    {String}   prefix
+ * @param    {string}   prefix
  */
 Document.setMethod(async function getTranslatedValueOfField(field_name, prefix) {
 	let doc = await this.getTranslatedDocumentOfPrefix(field_name, prefix);
@@ -836,11 +847,11 @@ Document.setMethod(async function getTranslatedValueOfField(field_name, prefix)
  * Get the translated value of a certain field.
  * If this document has already been translated, a new instance will be queried
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.10
  * @version  1.3.10
  *
- * @param    {String}   prefix
+ * @param    {string}   prefix
  */
 Document.setMethod(async function getTranslatedValueOfFieldForRoute(field_name, prefix) {
 	let doc = await this.getTranslatedDocumentOfPrefix(field_name, prefix);
@@ -868,7 +879,7 @@ Document.setMethod(async function refreshValues() {
 /**
  * Set the values
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
@@ -1090,7 +1101,7 @@ Document.setMethod(function recomputeValues() {
 /**
  * Get the clean options
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  *
@@ -1110,7 +1121,7 @@ Document.setMethod(function getCleanOptions() {
 /**
  * Save the updates to the record
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.0
  *
@@ -1217,7 +1228,7 @@ Document.setMethod(function save(data, options, callback) {
 /**
  * Check and do a datasource inform
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
@@ -1271,7 +1282,7 @@ Document.setMethod(function checkAndInformDatasource(options, callback) {
 /**
  * Inform the datasource of this document
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.1.0
  *
@@ -1363,7 +1374,7 @@ Document.setMethod(function informDatasource(options, callback) {
 /**
  * Store the current data as the original record
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
  * @version  1.3.1
  */
@@ -1378,11 +1389,11 @@ Document.setMethod(function storeCurrentDataAsOriginalRecord() {
 /**
  * Mark the given field as changed
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
  * @version  1.1.0
  *
- * @param    {String}   field_name   The name of the field that changed
+ * @param    {string}   field_name   The name of the field that changed
  * @param    {Mixed}    value        The new value of the field
  */
 Document.setMethod(function markChangedField(field_name, value) {
@@ -1401,7 +1412,7 @@ Document.setMethod(function markChangedField(field_name, value) {
 /**
  * Mark the document as being unchanged
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -1412,11 +1423,11 @@ Document.setMethod(function markUnchanged() {
 /**
  * Does this document need saving?
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
  * @version  1.0.4
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Document.setMethod(function needsToBeSaved() {
 
@@ -1434,11 +1445,11 @@ Document.setMethod(function needsToBeSaved() {
 /**
  * Does this document have object fields?
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
  * @version  1.0.4
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Document.setMethod(function hasObjectFields() {
 	// @TODO: implement schema checks
@@ -1448,13 +1459,13 @@ Document.setMethod(function hasObjectFields() {
 /**
  * Does this document have a value for the given field?
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.0.5
  *
- * @param    {String}   name   The field name
+ * @param    {string}   name   The field name
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Document.setMethod(function hasFieldValue(name) {
 	return Object.hasProperty(this.$main, name);
@@ -1463,13 +1474,13 @@ Document.setMethod(function hasFieldValue(name) {
 /**
  * Has this document changed since it was created?
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
  * @version  1.3.0
  *
- * @param    {String}   name   The optional field name
+ * @param    {string}   name   The optional field name
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Document.setMethod(function hasChanged(name) {
 
@@ -1538,11 +1549,11 @@ Document.setMethod(function hasChanged(name) {
 /**
  * Has this document beel validated?
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Document.setMethod(function hasValidated() {
 	return this.$attributes.validated;
@@ -1551,7 +1562,7 @@ Document.setMethod(function hasValidated() {
 /**
  * Reset this document to the initial values
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
  * @version  1.0.4
  *
@@ -1587,7 +1598,7 @@ Document.setMethod(function resetFields(fields) {
 /**
  * Keep these fields, and remove the others
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -1605,7 +1616,7 @@ Document.setMethod(function keepFields(fields) {
 /**
  * Get a list of possible validation violations
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
@@ -1622,7 +1633,7 @@ Document.setMethod(function getViolations() {
 /**
  * Validate the 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
  *
@@ -1647,7 +1658,7 @@ if (Blast.isNode) {
 /**
  * Get the local version of this document, if it exists
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.6
  * @version  1.1.0
  *
@@ -1685,7 +1696,7 @@ Document.setMethod(function getLocalVersion() {
 /**
  * Get the local version of this document, if it exists
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.6
  * @version  1.0.6
  *