alchemymvc 1.2.3 → 1.2.4

package/lib/app/{field → helper_field}/password_field.js

@@ -1,18 +1,20 @@
-var bcrypt = alchemy.use('bcrypt'),
-    regex  = /^\$2[ayb]\$/;
-
 /**
  * The Password Field class
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.2.3
  */
-var Password = Function.inherits('Alchemy.Field', function Password(schema, name, options) {
-	Password.super.call(this, schema, name, options);
-});
+const Password = Function.inherits('Alchemy.Field', 'Password');
+
+if (Blast.isBrowser) {
+	return true;
+}
+
+const bcrypt = alchemy.use('bcrypt'),
+      regex  = /^\$2[ayb]\$/;
 
 /**
  * Make sure the password is hashed before storing it

package/lib/app/helper_field/schema_field.js

@@ -5,7 +5,7 @@
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.3
+ * @version  1.2.4
  */
 var SchemaField = Function.inherits('Alchemy.Field', function Schema(schema, name, options) {
 	Schema.super.call(this, schema, name, options);
@@ -21,18 +21,20 @@ var SchemaField = Function.inherits('Alchemy.Field', function Schema(schema, nam
 		this.field_schema.setName(name);
 	}
 
-	if (!this.field_schema.parent || schema.root_schema == this.field_schema.parent) {
-		this.field_schema.setParent(schema);
-	} else {
-		// It's possible the given schema already had the correct parent
-		// But if that's not the case, throw an error
-		if (this.field_schema.parent != schema) {
-			throw new Error('Unable to re-use a schema for field "' + name + '", use `schema.clone()`!');
+	if (schema) {
+		if (!this.field_schema.parent || schema.root_schema == this.field_schema.parent) {
+			this.field_schema.setParent(schema);
+		} else {
+			// It's possible the given schema already had the correct parent
+			// But if that's not the case, throw an error
+			if (this.field_schema.parent != schema) {
+				throw new Error('Unable to re-use a schema for field "' + name + '", use `schema.clone()`!');
+			}
 		}
-	}
 
-	if (!this.field_schema.model_name) {
-		this.field_schema.setModel(schema.model_name);
+		if (!this.field_schema.model_name) {
+			this.field_schema.setModel(schema.model_name);
+		}
 	}
 });
 
@@ -242,7 +244,7 @@ SchemaField.setMethod(function _toDatasource(value, data, datasource, callback)
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.2.4
  *
  * @param    {Mixed}      value
  * @param    {Function}   callback
@@ -262,6 +264,12 @@ SchemaField.setMethod(function _toApp(query, options, value, callback) {
 		recursive = 1;
 	}
 
+	if (recursive && Blast.isBrowser) {
+		// @TODO: this will mostly fail on the browser, so disable it for now.
+		// Maybe make it configurable later
+		recursive = 0;
+	}
+
 	// Get associated records if the subschema has associations defined
 	if (recursive && this.field_schema && !Object.isEmpty(this.field_schema.associations)) {
 

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,7 +143,7 @@ DocumentList.setMethod(function createIterator() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.0.0
- * @version  1.2.3
+ * @version  1.2.4
  *
  * @return   {Object}
  */
@@ -152,16 +152,22 @@ DocumentList.setMethod(function toDry() {
 	let options;
 
 	if (this.options) {
-		let key;
+		let val,
+		    key;
 
 		options = {};
 
 		for (key in this.options) {
-			if (key == 'options' || key == 'assoc_cache') {
+			val = this.options[key];
+
+			if (key == 'options') {
+				val = Object.assign({}, val);
+				val.assoc_cache = undefined;
+			} else if (key == 'assoc_cache') {
 				continue;
 			}
 
-			options[key] = this.options[key];
+			options[key] = val;
 		}
 	}
 

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
  *

package/lib/class/document_list.js

@@ -115,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);
 });
 
 /**

package/lib/class/schema.js

@@ -287,7 +287,7 @@ Schema.setMethod(function getAssociationArguments(locality, alias, modelName, op
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.2.2
+ * @version  1.2.4
  *
  * @param    {String}   alias
  * @param    {String}   modelname
@@ -382,7 +382,8 @@ Schema.setMethod(function addAssociation(type, alias, modelName, options) {
 				doc_class.setFieldGetter(options.localKey);
 			}
 
-			if (client_doc && !options.is_private) {
+			// Also set is_private fields on the server-side client_doc!
+			if (client_doc) {
 				client_doc.setFieldGetter(options.localKey, null, null, false);
 			}
 		}
@@ -396,7 +397,8 @@ Schema.setMethod(function addAssociation(type, alias, modelName, options) {
 	if (constructor) {
 		doc_class.setAliasGetter(alias);
 
-		if (client_doc && !options.is_private) {
+		// Also set is_private fields on the server-side client_doc!
+		if (client_doc) {
 			client_doc.setAliasGetter(alias);
 		}
 	}

package/lib/class/schema_client.js

@@ -414,6 +414,37 @@ Schema.setMethod(function toHawkejs(wm) {
 	return result;
 });
 
+/**
+ * Get all the private fields
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.2.4
+ * @version  1.2.4
+ *
+ * @return   {Array}
+ */
+Schema.setMethod(function getPrivateFields() {
+
+	let result = [],
+	    field,
+	    i;
+
+	// Get the sorted fields
+	let fields = this.getSorted(false);
+
+	for (i = 0; i < fields.length; i++) {
+		field = fields[i];
+
+		if (field.is_private) {
+			field = Object.create(field);
+			field.schema = null;
+			result.push(field);
+		}
+	}
+
+	return result;
+});
+
 /**
  * Add a field to this schema
  *

package/lib/core/base.js

@@ -345,7 +345,7 @@ Base.setStatic('starts_new_group', false);
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.8
- * @version  1.1.8
+ * @version  1.2.4
  *
  * @type     {Conduit}
  */
@@ -355,16 +355,20 @@ Base.setProperty(function conduit() {
 		return this[CONDUIT];
 	}
 
-	let renderer = this.renderer || this.view || this.hawkejs_view,
+	let renderer,
 	    result;
+	
+	if (Blast.isBrowser || !(this instanceof Classes.Alchemy.Controller)) {
+		renderer = this.renderer || this.view || this.hawkejs_view;
+	}
 
-	if (renderer && renderer.conduit) {
+	if (renderer?.conduit) {
 		result = renderer.conduit;
-	} else if (renderer && renderer.root_renderer && renderer.root_renderer.conduit) {
+	} else if (renderer?.root_renderer?.conduit) {
 		result = renderer.root_renderer.conduit;
 	}
 
-	if (!conduit && renderer && renderer.server_var) {
+	if (!conduit && renderer?.server_var) {
 		result = renderer.server_var('conduit');
 	}
 
@@ -448,6 +452,39 @@ Base.setMethod(function callOrNext(name, args, next) {
 
 // PROTOBLAST START CUT
 
+/**
+ * Get the client implementation of this class
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.2.4
+ * @version  1.2.4
+ *
+ * @return   {Function}
+ */
+Base.setStatic(function getClientClass() {
+
+	if (!this.namespace) {
+		return;
+	}
+
+	// It's already a client-side class!
+	if (this.namespace.indexOf('.Client.')) {
+		return this;
+	}
+
+	// Add the Client part of the namespace
+	let namespace = this.namespace.replace('.Alchemy.', '.Alchemy.Client.');
+
+	// Get the actual namespace object
+	namespace = Function.getNamespace(namespace);
+
+	if (!namespace) {
+		return;
+	}
+
+	return namespace[this.name];
+});
+
 /**
  * Attach a conduit to a certain instance
  * 

package/lib/core/client_alchemy.js

@@ -1091,4 +1091,20 @@ Alchemy.setMethod(function syncDataWithServer() {
 Alchemy.setMethod(function createSchema(parent) {
 	let schema = new Classes.Alchemy.Client.Schema(parent);
 	return schema;
+});
+
+/**
+ * Get a client-side model
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.4
+ * @version  1.2.4
+ *
+ * @param   {String}   name
+ * @param   {Object}   options
+ *
+ * @return  {Model}
+ */
+Alchemy.setMethod(function getClientModel(name, init, options) {
+	return Classes.Alchemy.Client.Base.prototype.getModel.call(this, name, init, options);
 });

package/lib/core/client_base.js

@@ -233,7 +233,7 @@ ClientBase.setStatic(function mapEventToMethod(event_name, method_name) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.0.0
- * @version  1.1.8
+ * @version  1.2.4
  *
  * @param   {String}   name
  * @param   {Object}   options
@@ -255,9 +255,19 @@ ClientBase.setMethod(function getModel(name, init, options) {
 	}
 
 	if (Blast.isBrowser) {
-		constructor = Hawkejs.Model.getClass(name, false);
+
+		if (name == '') {
+			constructor = Hawkejs.Model;
+		} else {
+			constructor = Hawkejs.Model.getClass(name, false);
+		}
 	} else {
-		constructor = Blast.Classes.Hawkejs.Model.getClass(name);
+
+		if (name == '') {
+			constructor = Blast.Classes.Hawkejs.Model;
+		} else {
+			constructor = Blast.Classes.Hawkejs.Model.getClass(name);
+		}
 	}
 
 	if (!constructor) {

package/lib/init/alchemy.js

@@ -1749,6 +1749,22 @@ Alchemy.setMethod(function createSchema(parent) {
 	return schema;
 });
 
+/**
+ * Get a client-side model
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.4
+ * @version  1.2.4
+ *
+ * @param   {String}   name
+ * @param   {Object}   options
+ *
+ * @return  {Model}
+ */
+Alchemy.setMethod(function getClientModel(name, init, options) {
+	return Classes.Alchemy.Client.Base.prototype.getModel.call(this, name, init, options);
+});
+
 /**
  * The alchemy global, where everything will be stored
  *

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemymvc",
 	"description": "MVC framework for Node.js",
-	"version": "1.2.3",
+	"version": "1.2.4",
 	"author": "Jelle De Loecker <jelle@elevenways.be>",
 	"keywords": [
 		"alchemy",
@@ -22,7 +22,7 @@
 		"chokidar"         : "~3.5.3",
 		"formidable"       : "~1.2.2",
 		"graceful-fs"      : "~4.2.9",
-		"hawkejs"          : "~2.2.9",
+		"hawkejs"          : "~2.2.10",
 		"jsondiffpatch"    : "~0.4.1",
 		"mime"             : "~3.0.0",
 		"minimist"         : "~1.2.5",
@@ -31,7 +31,7 @@
 		"mongodb"          : "~3.6.6",
 		"ncp"              : "~2.0.0",
 		"postcss"          : "~8.4.6",
-		"protoblast"       : "~0.7.20",
+		"protoblast"       : "~0.7.21",
 		"semver"           : "~7.3.5",
 		"socket.io"        : "~2.4.0",
 		"@11ways/socket.io-stream" : "~0.9.2",