alchemy-form 0.1.6 → 0.1.7

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.1.7 (2022-06-12)
+
+* Fix `<alchemy-table>` code typo
+* Fix QueryBuilderGroup value being set incorrectly
+* Add `<alchemy-query-builder-value>` element
+* Add `<alchemy-query-builder-variable>` element
+* Add List variable definition, which can contain other variables
+
 ## 0.1.6 (2022-05-31)
 
 * Fix `FormApi#related` action searching through multiple fields in an `and` group

package/element/25_query_builder_data.js

@@ -0,0 +1,139 @@
+/**
+ * The base abstract query builder custom element
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+const QueryBuilderData = Function.inherits('Alchemy.Element.Form.QueryBuilderBase', 'QueryBuilderData');
+
+/**
+ * Don't register this as a custom element,
+ * but don't let child classes inherit this
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+QueryBuilderData.setStatic('is_abstract_class', true, false);
+
+/**
+ * Check a filter
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.7
+ */
+QueryBuilderData.setMethod(function checkFilterType(filter_type, entry) {
+
+	if (!entry) {
+		return false;
+	}
+
+	let whitelist = this[filter_type];
+
+	if (!whitelist) {
+		return true;
+	}
+
+	let type = entry.type_name || entry.type || entry.id || entry.name;
+
+	if (!type) {
+		return false;
+	}
+
+	let entries = whitelist.split(',');
+
+	return entries.indexOf(type) > -1;
+});
+
+/**
+ * Load data for a specific element
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+QueryBuilderData.setMethod(async function loadData(config, element) {
+
+	if (!element) {
+		return;
+	}
+
+	if (!config) {
+		config = {};
+	}
+
+	let filter_type,
+	    result = [],
+	    items;
+
+	if (element.classList.contains('qb-source-type')) {
+		items = await this.loadSourceTypeData(config);
+		filter_type = 'source-types';
+	} else if (element.classList.contains('qb-value-variable') || element.classList.contains('qb-variable')) {
+		items = await this.loadVariableData(config);
+		filter_type = 'variable-types';
+	}
+
+	if (items && items.length) {
+
+		let entry;
+
+		for (entry of items) {
+			if (!entry) {
+				continue;
+			}
+
+			if (filter_type && !this.checkFilterType(filter_type, entry)) {
+				continue;
+			}
+
+			result.push(entry);
+		}
+	}
+
+	return {
+		items: result,
+	};
+});
+
+/**
+ * Load variable data
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.7
+ */
+QueryBuilderData.setMethod(async function loadVariableData(config) {
+
+	let dataprovider = this.dataprovider;
+
+	if (!config) {
+		config = {};
+	}
+
+	config.source_type = 'variable';
+
+	let variables = [];
+
+	if (dataprovider) {
+		variables = await dataprovider.loadData(config, this);
+	}
+
+	let result = [];
+
+	if (variables && variables.length) {
+		let entry;
+
+		for (entry of variables) {
+			if (entry) {
+				result.push(entry);
+			}
+		}
+	}
+
+	console.log('Got loadvariable data:', result);
+
+	return result;
+});

package/element/alchemy_table.js

@@ -709,7 +709,7 @@ Table.setMethod(function getEntryActions(record, filter) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.6
- * @version  0.1.6
+ * @version  0.1.7
  *
  * @param    {Object}   entry
  */
@@ -728,7 +728,7 @@ Table.setMethod(function attachContextMenus() {
 		let context_actions = this.getEntryActions(record, 'context');
 
 		if (!context_actions || !context_actions.length) {
-			contintue;
+			continue;
 		}
 
 		let pk = record.$pk || record._id || record.id;

package/element/query_builder.js

@@ -73,7 +73,7 @@ QueryBuilder.setMethod(function applyValue(value) {
 		return;
 	}
 
-	this.root_group.applyValue(value);
+	this.root_group.value = value;
 });
 
 /**

package/element/query_builder_group.js

@@ -104,7 +104,7 @@ QueryBuilderGroup.setProperty(function group_type() {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.6
- * @version  0.1.6
+ * @version  0.1.7
  */
 QueryBuilderGroup.setProperty(function inverted() {
 
@@ -116,8 +116,17 @@ QueryBuilderGroup.setProperty(function inverted() {
 
 	return false;
 }, function setInverted(value) {
-	let input = this.header.querySelector('.qb-group-invert input');
-	input.checked = value;
+
+	if (!this.assigned_data.value) {
+		this.assigned_data.value = {};
+	}
+
+	this.assigned_data.value.inverted = value;
+
+	if (this.header) {
+		let input = this.header.querySelector('.qb-group-invert input');
+		input.checked = value;
+	}
 });
 
 /**
@@ -125,7 +134,7 @@ QueryBuilderGroup.setProperty(function inverted() {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.6
- * @version  0.1.6
+ * @version  0.1.7
  */
 QueryBuilderGroup.setProperty(function value() {
 
@@ -148,6 +157,13 @@ QueryBuilderGroup.setProperty(function value() {
 	}
 
 	return result;
+}, function setValue(value) {
+
+	this.assigned_data.value = value;
+
+	if (this.has_rendered) {
+		this.applyValue(value);
+	}
 });
 
 /**
@@ -155,7 +171,7 @@ QueryBuilderGroup.setProperty(function value() {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.6
- * @version  0.1.6
+ * @version  0.1.7
  */
 QueryBuilderGroup.setMethod(function applyValue(value) {
 
@@ -163,15 +179,25 @@ QueryBuilderGroup.setMethod(function applyValue(value) {
 		return;
 	}
 
+	// Keep track of how many time a value has been applied
+	// (needed for the initial value setter)
+	if (!this.applied_value_counter) {
+		this.applied_value_counter = 0;
+	}
+
+	this.applied_value_counter++;
+
 	this.inverted = value.inverted;
 	this.group_type = value.condition;
 
+	Hawkejs.removeChildren(this.rules_list);
+
 	if (value.rules && value.rules.length) {
 		let element,
 		    rule;
 
 		for (rule of value.rules) {
-			if (rule.type == 'field') {
+			if (rule.type == 'qb_entry') {
 				element = this.createElement('alchemy-query-builder-entry');
 			} else {
 				element = this.createElement('alchemy-query-builder-group');
@@ -188,7 +214,7 @@ QueryBuilderGroup.setMethod(function applyValue(value) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.6
- * @version  0.1.6
+ * @version  0.1.7
  */
 QueryBuilderGroup.setMethod(function introduced() {
 
@@ -215,7 +241,8 @@ QueryBuilderGroup.setMethod(function introduced() {
 		this.remove();
 	});
 
-	if (this.assigned_data.value) {
+	// Apply the value if it hasn't been done already
+	if (this.assigned_data.value && !this.applied_value_counter) {
 		this.applyValue(this.assigned_data.value);
 	}
 });

package/element/query_builder_value.js

@@ -5,7 +5,7 @@
  * @since    0.1.6
  * @version  0.1.6
  */
-const QueryBuilderValue = Function.inherits('Alchemy.Element.Form.QueryBuilderBase', 'QueryBuilderValue');
+const QueryBuilderValue = Function.inherits('Alchemy.Element.Form.QueryBuilderData', 'QueryBuilderValue');
 
 /**
  * The template to use for the content of this element
@@ -124,125 +124,6 @@ QueryBuilderValue.setProperty(function value() {
 	this.assigned_data.value = value;
 });
 
-/**
- * Check a filter
- *
- * @author   Jelle De Loecker <jelle@elevenways.be>
- * @since    0.1.6
- * @version  0.1.6
- */
-QueryBuilderValue.setMethod(function checkFilterType(filter_type, entry) {
-
-	if (!entry) {
-		return false;
-	}
-
-	let whitelist = this[filter_type];
-
-	if (!whitelist) {
-		return true;
-	}
-
-	let type = entry.type_name || entry.type || entry.id || entry.name;
-
-	if (!type) {
-		return false;
-	}
-
-	let entries = whitelist.split(',');
-
-	return entries.indexOf(type) > -1;
-});
-
-/**
- * Load data for a specific element
- *
- * @author   Jelle De Loecker <jelle@elevenways.be>
- * @since    0.1.6
- * @version  0.1.6
- */
-QueryBuilderValue.setMethod(async function loadData(config, element) {
-
-	if (!element) {
-		return;
-	}
-
-	if (!config) {
-		config = {};
-	}
-
-	let filter_type,
-	    result = [],
-	    items;
-
-	if (element.classList.contains('qb-source-type')) {
-		items = await this.loadSourceTypeData(config);
-		filter_type = 'source-types';
-	} else if (element.classList.contains('qb-value-variable')) {
-		items = await this.loadVariableData(config);
-		filter_type = 'variable-types';
-	}
-
-	if (items && items.length) {
-
-		let entry;
-
-		for (entry of items) {
-			if (!entry) {
-				continue;
-			}
-
-			if (filter_type && !this.checkFilterType(filter_type, entry)) {
-				continue;
-			}
-
-			result.push(entry);
-		}
-	}
-
-	return {
-		items: result,
-	};
-});
-
-/**
- * Load variable data
- *
- * @author   Jelle De Loecker <jelle@elevenways.be>
- * @since    0.1.6
- * @version  0.1.6
- */
-QueryBuilderValue.setMethod(async function loadVariableData(config) {
-
-	let dataprovider = this.dataprovider;
-
-	if (!config) {
-		config = {};
-	}
-
-	config.source_type = 'variable';
-
-	let variables = [];
-
-	if (dataprovider) {
-		variables = await dataprovider.loadData(config, this);
-	}
-
-	let result = [];
-
-	if (variables && variables.length) {
-		let entry;
-
-		for (entry of variables) {
-			if (entry) {
-				result.push(entry);
-			}
-		}
-	}
-
-	return result;
-});
-
 /**
  * Load value type data
  *

package/element/query_builder_variable.js

@@ -0,0 +1,103 @@
+/**
+ * The alchemy-query-builder-value custom element
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+const QueryBuilderVariable = Function.inherits('Alchemy.Element.Form.QueryBuilderData', 'QueryBuilderVariable');
+
+/**
+ * The template to use for the content of this element
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+QueryBuilderVariable.setTemplateFile('form/elements/query_builder_variable');
+
+/**
+ * A filter of variable definition types
+ * (number, string, ...)
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+QueryBuilderVariable.setAttribute('variable-types');
+
+/**
+ * Getter for the value input wrapper
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+QueryBuilderVariable.addElementGetter('variable_select', '.qb-variable');
+
+/**
+ * Get/set the value
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+QueryBuilderVariable.setProperty(function value() {
+
+	let result = {
+		type          : 'qb_variable',
+		variable_type : null,
+	};
+
+	let select = this.variable_select;
+
+	if (select) {
+		result.variable = select.value;
+
+		if (select.values) {
+			let value_def = select.values[result.variable];
+
+			if (value_def) {
+				result.variable_type = value_def.type_name;
+			}
+		}
+	}
+
+	return result;
+}, function setValue(value) {
+	this.assigned_data.value = value;
+});
+
+/**
+ * Apply the given value
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+QueryBuilderVariable.setMethod(async function applyValue(value) {
+
+	if (!value) {
+		return;
+	}
+
+	let select = this.variable_select;
+
+	if (select) {
+		select.value = value.variable;
+	}
+});
+
+/**
+ * Added to the dom
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+QueryBuilderVariable.setMethod(async function introduced() {
+
+	if (this.assigned_data.value) {
+		await this.applyValue(this.assigned_data.value);
+	}
+});

package/helper/query_builder_variable_definition/00_variable_definition.js

@@ -154,10 +154,20 @@ VariableDefinition.setStatic(function addLogicalOperator(name, config) {
 		config = {};
 	}
 
-	if(!config.title) {
+	if (!config.title) {
 		config.title = name.titleize();
 	}
 
+	// By default logical operators have a binary arity:
+	// they take 2 operands. The value of the variable + another value.
+	if (!config.arity) {
+		config.arity = 'binary';
+	}
+
+	if (config.arity != 'unary' && config.arity != 'binary' && config.arity != 'ternary') {
+		throw new Error('Unable to add Logical operator "' + name + '" to ' + this.name + ', unknown arity: "' + config.arity);
+	}
+
 	config.id = name;
 
 	this.constitute(function _addOperator() {
@@ -185,10 +195,20 @@ VariableDefinition.setStatic(function addAssignmentOperator(name, config) {
 		config = {};
 	}
 
-	if(!config.title) {
+	if (!config.title) {
 		config.title = name.titleize();
 	}
 
+	// By default assignment operators have a binary arity:
+	// they take 2 operands. The value of the variable + another value
+	if (!config.arity) {
+		config.arity = 'binary';
+	}
+
+	if (config.arity != 'unary' && config.arity != 'binary' && config.arity != 'ternary') {
+		throw new Error('Unable to add Assignment operator "' + name + '" to ' + this.name + ', unknown arity: "' + config.arity);
+	}
+
 	config.id = name;
 
 	this.constitute(function _addOperator() {
@@ -330,7 +350,7 @@ VariableDefinition.addLogicalOperator('not_equals');
  * @since    0.1.6
  * @version  0.1.6
  */
-VariableDefinition.addLogicalOperator('is_empty');
+VariableDefinition.addLogicalOperator('is_empty', {arity: 'unary'});
 
 /**
  * The `is_null` operator
@@ -339,7 +359,7 @@ VariableDefinition.addLogicalOperator('is_empty');
  * @since    0.1.6
  * @version  0.1.6
  */
-VariableDefinition.addLogicalOperator('is_null');
+VariableDefinition.addLogicalOperator('is_null', {arity: 'unary'});
 
 /**
  * The `set` operator sets a value

package/helper/query_builder_variable_definition/list_variable_definition.js

@@ -0,0 +1,38 @@
+/**
+ * The List Value Type:
+ * Can contain other value types.
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+const ListDefinition = Function.inherits('Alchemy.QueryBuilder.VariableDefinition', 'List');
+
+/**
+ * The optional type this list holds
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+ListDefinition.setProperty('content_type');
+
+/**
+ * The `contains` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+ListDefinition.addLogicalOperator('contains');
+
+/**
+ * The `add` assignment operator adds an entry
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+ListDefinition.addAssignmentOperator('add');

package/helper_field/query_builder_variable.js

@@ -0,0 +1,56 @@
+/**
+ * A QueryBuilderVariable field lets you select a specific variable
+ * using the QueryBuilder logic
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+const QueryBuilderVariable = Function.inherits('Alchemy.Field.QueryBuilder', 'QueryBuilderVariable');
+
+/**
+ * Load remote data
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ *
+ * @param    {Object}        config
+ * @param    {HTMLElement}   element
+ */
+QueryBuilderVariable.setMethod(function loadData(config, element) {
+
+	if (element) {
+		let form = element.queryParents('alchemy-form');
+
+		if (form) {
+			let doc = form.document;
+
+			if (doc && doc.root_document) {
+				doc = doc.root_document;
+			}
+
+			let model_name,
+				$pk;
+			
+			if (doc) {
+				model_name = doc.$model_name;
+				$pk = doc.$pk;
+			}
+
+			return element.hawkejs_helpers.Alchemy.getResource({
+				name  : 'FormApi#queryBuilderData',
+				post  : true,
+				body  : {
+					model        : model_name,
+					$pk          : $pk,
+					config       : config,
+				}
+			});
+		}
+	}
+
+	return [];
+});

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemy-form",
 	"description": "Form plugin for Alchemy",
-	"version": "0.1.6",
+	"version": "0.1.7",
 	"repository": {
 		"type" : "git",
 		"url"  : "https://github.com/11ways/alchemy-form.git"

package/view/form/elements/query_builder_variable.hwk

@@ -0,0 +1,6 @@
+<alchemy-select
+	class="qb-variable"
+	#dataprovider={% self %}
+	value-item-template="form/select/qb_item"
+	option-item-template="form/select/qb_item"
+></alchemy-select>

package/view/form/inputs/edit/query_builder_variable.hwk

@@ -0,0 +1,10 @@
+<%
+options = alchemy_field.config.options || {};
+%>
+
+<alchemy-query-builder-variable
+	class="alchemy-field-value"
+	#value={% value %}
+	#dataprovider={% alchemy_field %}
+	variable-types={% options.variable_types %}
+></alchemy-query-builder-variable>