alchemy-widget 0.1.4 → 0.1.5

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.5 (2022-07-14)
+
+* Unselect widgets when stopping the editor
+* Add front-end save ability to widgets
+
 ## 0.1.4 (2022-06-23)
 
 * Use `he-context-menu` element to show widgets to add

package/bootstrap.js

@@ -0,0 +1,6 @@
+Router.add({
+	name       : 'AlchemyWidgets#save',
+	methods    : 'post',
+	paths      : '/api/alchemywidgets/save',
+	policy     : 'logged_in',
+});

package/controller/alchemy_widgets_controller.js

@@ -0,0 +1,111 @@
+/**
+ * The Alchemy Widgets Controller class
+ *
+ * @author     Jelle De Loecker   <jelle@elevenways.be>
+ * @since      0.1.5
+ * @version    0.1.5
+ */
+const AlchemyWidgets = Function.inherits('Alchemy.Controller', 'AlchemyWidgets');
+
+/**
+ * Aggregate all the records to save
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ *
+ * @param    {Object[]}   fields
+ *
+ * @return   {Document[]}
+ */
+AlchemyWidgets.setMethod(async function aggregate(widgets) {
+
+	let result = {};
+
+	for (let widget of widgets) {
+
+		if (!widget || !widget.model || !widget.field) {
+			throw new Error('Unable to save Widget: no model or field was given');
+		}
+	
+		const model = alchemy.getModel(widget.model);
+	
+		if (!model) {
+			throw new Error('Unable to save Widget: model "' + widget.model + '" not found');
+		}
+	
+		let field = model.getField(widget.field);
+	
+		if (!field) {
+			throw new Error('Unable to save Widget: field "' + widget.field + '" does not exist inside model "' + widget.model + '"');
+		}
+	
+		let record;
+	
+		if (widget.pk) {
+
+			if (result[widget.pk]) {
+				record = result[widget.pk];
+			} else {
+				record = await model.findByPk(widget.pk);
+				result[widget.pk] = record;
+			}
+		} else {
+
+			if (result[model.name]) {
+				record = result[model.name];
+			} else {
+				record = model.createDocument();
+				result[model.name] = record;
+			}
+		}
+	
+		let field_language = widget.field_languages?.[widget.field];
+	
+		if (field_language) {
+			if (!record[widget.field]) {
+				record[widget.field] = {};
+			}
+	
+			record[widget.field][field_language] = widget.value;
+		} else {
+			record[widget.field] = widget.value;
+		}
+	}
+
+	return Object.values(result);
+});
+
+/**
+ * The save action
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ *
+ * @param    {Conduit}   conduit
+ */
+AlchemyWidgets.setAction(async function save(conduit) {
+
+	const body = conduit.body;
+
+	if (!body || !body.widgets?.length) {
+		return conduit.error('Unable to save Widgets: no widgets were given');
+	}
+
+	let records = await this.aggregate(body.widgets);
+
+	let saved_pks = [];
+
+	for (let record of records) {
+		await record.save();
+		saved_pks.push(record.$pk);
+	}
+
+	let result = {
+		saved_pks,
+		saved : true,
+	};
+
+	conduit.end(result);
+});

package/element/00-widget_base_element.js

@@ -83,6 +83,37 @@ Base.setProperty(function previous_container() {
 	return this.getSiblingContainer('previous');
 });
 
+/**
+ * Is this the root element?
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ */
+Base.setProperty(function is_root_widget() {
+	return !this.parent_container;
+});
+
+/**
+ * Can this widget be saved?
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ */
+Base.setProperty(function can_be_saved() {
+
+	if (!this.is_root_widget) {
+		return false;
+	}
+
+	if (!this.record || !this.field) {
+		return false;
+	}
+
+	return true;
+});
+
 /**
  * Get a sibling container
  *
@@ -208,5 +239,57 @@ Base.setMethod(function introduced() {
 	if (this.hasAttribute('editing')) {
 		this.startEditor();
 	}
+});
+
+/**
+ * Get the configuration used to save data
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ */
+Base.setMethod(function gatherSaveData() {
+
+	if (!this.is_root_widget) {
+		return;
+	}
+
+	if (!this.record || !this.field) {
+		return;
+	}
+
+	let result = {
+		model : this.record.$model_name,
+		pk    : this.record.$pk,
+		field : this.field,
+		value : this.value,
+		field_languages : this.record.$hold.translated_fields,
+	};
+
+	return result;
+});
+
+/**
+ * Save the current configuration
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ */
+Base.setMethod(async function save() {
+
+	let data = this.gatherSaveData();
+	
+	if (!data) {
+		return;
+	}
+
+	let config = {
+		href : alchemy.routeUrl('AlchemyWidgets#save'),
+		post : {
+			widgets: [data]
+		}
+	};
 
+	let result = await alchemy.fetch(config);
 });

package/element/05-widget_element.js

@@ -34,6 +34,24 @@ Widget.setAttribute('type');
  */
 Widget.setProperty('is_alchemy_widget', true);
 
+/**
+ * The database record to work with
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ */
+Widget.setAssignedProperty('record');
+
+/**
+ * The fieldname in the record to work with
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ */
+Widget.setAssignedProperty('field');
+
 /**
  * Is this widget being edited?
  *
@@ -55,7 +73,7 @@ Widget.setProperty(function editing() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.1.0
+ * @version  0.1.5
  */
 Widget.setProperty(function value() {
 	return {
@@ -63,6 +81,45 @@ Widget.setProperty(function value() {
 		config   : this.instance.syncConfig(),
 	}
 }, function setValue(value) {
+	this.applyValue(value);
+});
+
+/**
+ * Received a new record
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ */
+Widget.setMethod(function onRecordAssignment(new_record, old_val) {
+	if (new_record && this.field) {
+		let value = new_record[this.field];
+		this.applyValue(value);
+	}
+});
+
+/**
+ * Received a new field name
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ */
+Widget.setMethod(function onFieldAssignment(new_field, old_val) {
+	if (new_field && this.record) {
+		let value = this.record[new_field];
+		this.applyValue(value);
+	}
+});
+
+/**
+ * Apply the given value
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ */
+Widget.setMethod(function applyValue(value) {
 
 	let config,
 	    type;
@@ -136,7 +193,7 @@ Widget.setMethod(function startEditor() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.1.0
+ * @version  0.1.5
  */
 Widget.setMethod(function stopEditor() {
 
@@ -144,6 +201,7 @@ Widget.setMethod(function stopEditor() {
 		throw new Error('Unable to stop the editor: this widget element has no accompanying instance');
 	}
 
+	this.unselectWidget();
 	this.instance.stopEditor();
 	this.removeEditEventListeners();
 });

package/element/10-container_elements.js

@@ -83,6 +83,17 @@ AlchemyWidgets.setProperty(function value() {
 	return result;
 
 }, function setValue(value) {
+	this.applyValue(value);
+});
+
+/**
+ * Apply the given value
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.5
+ * @version  0.1.5
+ */
+AlchemyWidgets.setMethod(function applyValue(value) {
 
 	let widgets,
 	    config;

package/helper/widgets/00-widget.js

@@ -95,7 +95,7 @@ Widget.enforceProperty(function hawkejs_renderer(new_value) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.1.0
+ * @version  0.1.5
  */
 Widget.constitute(function prepareSchema() {
 
@@ -120,6 +120,17 @@ Widget.constitute(function prepareSchema() {
 		array: true,
 	});
 
+	// Add the "save" action
+	let save = this.createAction('save', 'Save');
+
+	save.setHandler(function removeAction(widget_el, handle) {
+		return widget_el.save();
+	});
+
+	save.setTester(function saveAction(widget_el, handle) {
+		return widget_el.can_be_saved;
+	});
+
 	// Add the remove action
 	let remove = this.createAction('remove', 'Remove');
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemy-widget",
 	"description": "The widget plugin for the AlchemyMVC",
-	"version": "0.1.4",
+	"version": "0.1.5",
 	"author": "Jelle De Loecker <jelle@elevenways.be>",
 	"keywords": [
 		"alchemy",