alchemy-form 0.2.9 → 0.3.0-alpha.1

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.3.0-alpha.1 (2024-02-15)
+
+* Upgrade to Alchemy v1.4.0
+* Add edit template for the `Object` field type
+* Add settings editor element
+* Make `readonly` attribute work on `al-field` and `al-form` elements
+* Use "alchemy-field-title" and "alchemy-field-description" microcopy in `al-field` labels
+
+## 0.2.10 (2024-01-15)
+
+* Fix `al-table` throwing an error when receiving null data
+* Add `al-virtual-scroll` element
+* Make field `constraints` work by using the `Document` instance instead of plain data object
+* Clear old errors when validating a form
+
 ## 0.2.9 (2023-11-27)
 
 * Add support for new local Date/Time fields & Decimal fields

package/assets/stylesheets/form/elements/_code_input.scss

@@ -1,6 +1,5 @@
 al-code-input {
 	display: inline-block;
-	height: 30rem;
 	width: 100%;
 	position: relative;
 

package/assets/stylesheets/form/elements/_field.scss

@@ -33,4 +33,19 @@ al-field {
 			display: inline-flex;
 		}
 	}
+
+	.alchemy-field-empty-value {
+		color: #666;
+		font-style: italic;
+	}
+}
+
+al-form[readonly] al-field,
+al-field[readonly] {
+	pointer-events: none;
+
+	.alchemy-field-value {
+		opacity: 0.8;
+		filter: brightness(0.95);
+	}
 }

package/assets/stylesheets/form/elements/_settings_editor.scss

@@ -0,0 +1,62 @@
+al-settings-editor {
+	display: grid;
+	grid-template-columns: minmax(200px, 1.5fr) minmax(25vw, 9fr);
+
+	.al-settings-group {
+		padding-top: 0.5rem;
+		margin-bottom: 0.5rem;
+	}
+
+	.al-settings-setting-header {
+		margin-bottom: 0.5rem;
+	}
+
+	.al-settings-group-title {
+		font-weight: bold;
+		font-size: 1.6rem;
+	}
+
+	.al-settings-group-header {
+		padding: 0.2rem 1rem 0.5rem;
+	}
+
+	.al-settings-actions,
+	.al-settings-setting {
+		padding: 0.2rem 1rem 1.5rem;
+	}
+
+	.al-settings-actions {
+		margin-top: 2rem;
+	}
+
+	.al-settings-setting-title {
+		font-weight: bold;
+	}
+
+	.al-settings-setting-description micro-copy:not(:empty) {
+		display: block;
+		margin-top: 0.3rem;
+	}
+
+	.al-settings-sidebar {
+		border-right: 1px solid #ebebeb;
+		margin-right: 1.5rem;
+
+		a {
+			text-decoration: none;
+			color: inherit;
+		}
+	}
+
+	al-field {
+		.field,
+		.field input {
+			width: 100%;
+		}
+	}
+
+	al-toc {
+		position: sticky;
+		top: 1rem;
+	}
+}

package/assets/stylesheets/form/elements/_table.scss

@@ -4,7 +4,6 @@ al-table {
 	border: 1px solid #dadee0;
 	font-family: sans-serif;
 	background-color: white;
-	color: #313131;
 
 	table {
 		border-collapse: collapse;

package/assets/stylesheets/form/elements/_virtual_scroll.scss

@@ -0,0 +1,19 @@
+al-virtual-scroll {
+	display: block;
+	min-height: 20rem;
+	min-width: 2rem;
+	overflow: auto;
+	border: 1px solid red;
+
+	.top-trigger,
+	.bottom-trigger {
+		width: 1px;
+		height: 1px;
+	}
+
+	[data-loaded-entry-index] {
+		border: 1px solid orange;
+		min-height: 2rem;
+		padding: 1rem;
+	}
+}

package/assets/stylesheets/form/elements/index.scss

@@ -13,4 +13,6 @@
 @import "_toggle.scss";
 @import "_tabs.scss";
 @import "_pathway.scss";
-@import "_apex_charts.scss";
+@import "_apex_charts.scss";
+@import "_virtual_scroll.scss";
+@import "_settings_editor.scss";

package/config/routes.js

@@ -1,4 +1,4 @@
-Router.add({
+Plugin.addRoute({
 	name       : 'FormApi#related',
 	methods    : 'post',
 	paths      : '/api/form/data/related',
@@ -7,7 +7,7 @@ Router.add({
 	is_system_route : true,
 });
 
-Router.add({
+Plugin.addRoute({
 	name       : 'FormApi#queryBuilderData',
 	methods    : 'post',
 	paths      : '/api/form/data/qbdata',
@@ -16,7 +16,7 @@ Router.add({
 	is_system_route : true,
 });
 
-Router.add({
+Plugin.addRoute({
 	name            : 'FormApi#recompute',
 	methods         : 'post',
 	paths           : '/api/form/data/recompute/{model_name}/{field}',

package/controller/form_api_controller.js

@@ -17,7 +17,7 @@ const FormApi = Function.inherits('Alchemy.Controller', 'FormApi');
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.2.9
+ * @version  0.3.0
  *
  * @param    {Conduit}   conduit
  */
@@ -32,9 +32,7 @@ FormApi.setAction(async function related(conduit) {
 	crit.setOption('scenario', 'related_data');
 
 	if (body.constraints) {
-		for (let key in body.constraints) {
-			crit.where(key).equals(body.constraints[key]);
-		}
+		crit.applyConditions(body.constraints);
 	}
 
 	if (config.value) {

package/element/00_form_base.js

@@ -102,6 +102,27 @@ Base.setAttribute('purpose', function getPurpose(value) {
  */
 Base.setAttribute('mode');
 
+/**
+ * The zone determines where the form/field is being used.
+ * For example: admin, frontend, chimera, invoice, ...
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.3.0
+ * @version  0.3.0
+ */
+Base.setAttribute('zone', function getZone(value) {
+
+	if (value) {
+		return value;
+	}
+
+	if (!value && this.alchemy_form) {
+		value = this.alchemy_form.zone;
+	}
+
+	return value;
+});
+
 /**
  * The view-type determines which type of wrapper/field to use,
  * e.g.: view, list, edit, ...

package/element/al_code_input.js

@@ -43,6 +43,15 @@ CodeInput.setAttribute('language-mode');
  */
 CodeInput.setAttribute('color-theme');
 
+/**
+ * Is the value an object?
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.3.0
+ * @version  0.3.0
+ */
+CodeInput.setAttribute('value-is-object', {type: 'boolean'});
+
 /**
  * The minimum number of lines to show (height)
  *
@@ -66,25 +75,43 @@ CodeInput.setAttribute('max-lines', {type: 'number'});
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.2.5
+ * @version  0.3.0
  */
-CodeInput.setProperty(function value(value) {
+CodeInput.setProperty(function value() {
+
+	let result;
 
 	if (this._editor) {
-		return this._editor.getValue();
+		result = this._editor.getValue();
+	} else {
+		let editor_el = this.querySelector('.code-editor');
+
+		if (editor_el) {
+			result = editor_el.textContent;
+		} else {
+			if (this.assigned_data.value) {
+				return this.assigned_data.value;
+			}
+
+			return;
+		}
 	}
 
-	let editor_el = this.querySelector('.code-editor');
-
-	if (editor_el) {
-		return editor_el.textContent;
+	if (result && this.value_is_object) {
+		result = JSON.safeParse(result);
 	}
 
-	if (this.assigned_data.value) {
-		return this.assigned_data.value;
-	}
+	return result;
+
+}, function setValue(original_value) {
 
-}, function setValue(value) {
+	let value;
+
+	if (this.value_is_object) {
+		value = JSON.stringify(value, null, '\t');
+	} else {
+		value = original_value;
+	}
 
 	if (this._editor) {
 		this._editor.setValue(value);
@@ -101,7 +128,9 @@ CodeInput.setProperty(function value(value) {
 		return editor_el.textContent = value;
 	}
 
-	this.assigned_data.value = value;
+	this.assigned_data.value = original_value;
+
+	this.hawkejs_renderer.registerElementInstance(this);
 });
 
 /**
@@ -153,7 +182,14 @@ CodeInput.setMethod(async function introduced() {
 	}
 
 	if (this.assigned_data.value) {
-		editor.setValue(this.assigned_data.value, -1);
+
+		let value = this.assigned_data.value;
+
+		if (this.value_is_object) {
+			value = JSON.stringify(value, null, '\t');
+		}
+
+		editor.setValue(value, -1);
 	}
 
 	if (this.language_mode) {
@@ -164,5 +200,7 @@ CodeInput.setMethod(async function introduced() {
 		}
 	}
 
+	this.style.height = null;
+
 	this._editor = editor;
 });

package/element/al_field.js

@@ -77,9 +77,17 @@ Field.setAttribute('wrapper-view');
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.2
- * @version  0.1.2
+ * @version  0.3.0
  */
-Field.setAttribute('readonly', {boolean: true});
+Field.setAttribute('readonly', function getReadonlyValue(current_value) {
+
+	if (current_value == null) {
+		current_value = this.alchemy_form?.readonly;
+	}
+
+	return current_value;
+
+}, {boolean: true});
 
 /**
  * Widget settings for use in the views
@@ -585,14 +593,20 @@ Field.setProperty(function value_element() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.2.9
+ * @version  0.3.0
  */
 Field.setProperty(function value() {
 
 	let element = this.value_element;
 
 	if (element) {
-		return element.value;
+		let value = element.value;
+
+		if (this.config) {
+			value = this.config.castContainedValues(value);
+		}
+
+		return value;
 	}
 
 	return this.value_to_render;
@@ -1043,32 +1057,19 @@ Field.setMethod(async function loadData(config, element) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.9
- * @version  0.2.9
+ * @version  0.3.0
  *
- * @param    {Object}   constraints
+ * @param    {Criteria|Object}   constraints
+ *
+ * @param    {Object}
  */
 Field.setMethod(function resolveConstraintInstruction(constraints) {
 
-	let context,
-	    result = {},
-	    value,
-	    key;
-
-	for (key in constraints) {
-		value = constraints[key];
+	let context = {$0: this.alchemy_form.getValueAsDocument()};
 
-		if (value && typeof value == 'object') {
-			if (value instanceof Classes.Alchemy.PathEvaluator) {
-				if (!context && this.alchemy_form) {
-					context = this.alchemy_form.getMainValue();
-				}
+	constraints = Classes.Alchemy.Criteria.Criteria.cast(constraints);
 
-				result[key] = value.getValue({$0: context}) ?? null;
-			}
-		} else {
-			result[key] = value;
-		}
-	}
+	let result = constraints.compileToConditions(context);
 
 	return result;
 });

package/element/al_form.js

@@ -34,6 +34,15 @@ Form.setAttribute('method');
  */
 Form.setAttribute('model');
 
+/**
+ * Is this a read only form?
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.3.0
+ * @version  0.3.0
+ */
+Form.setAttribute('readonly', {boolean: true});
+
 /**
  * Should the entire document be submitted?
  *
@@ -249,8 +258,6 @@ Form.setMethod(function setDocument(document) {
 	// Set the current document
 	this.document = document;
 
-	console.log('Setting document', document);
-
 	for (let key in current_value) {
 		let original_value = current_value[key],
 		    new_value = document[key];
@@ -271,7 +278,7 @@ Form.setMethod(function setDocument(document) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.2
- * @version  0.2.9
+ * @version  0.2.10
  */
 Form.setMethod(async function validate() {
 
@@ -279,11 +286,12 @@ Form.setMethod(async function validate() {
 
 	let violations = await doc.getViolations();
 
+	this.clearErrors();
+
 	if (violations) {
 		this.showError(violations);
 		throw violations;
 	}
-
 });
 
 /**

package/element/al_select.js

@@ -951,12 +951,13 @@ AlchemySelect.setMethod(function getRemoteFetchConfig() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  0.2.0
+ * @version  0.3.0
  */
 AlchemySelect.setMethod(function applyFetchedData(err, result, config) {
 
 	if (err) {
 		this.loading_dropdown = false;
+		alchemy.handleError(err);
 		return;
 	}