alchemy-form 0.2.10 → 0.3.0-alpha.2

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;
@@ -636,8 +650,72 @@ Field.setProperty(function value_to_render() {
 	}
 });
 
+/**
+ * Get the placeholder for empty values (if any)
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.3.0
+ * @version  0.3.0
+ */
+Field.setProperty(function allow_empty_value_placeholder() {
+	return !!(this.applied_options?.empty_value_placeholder ?? true);
+});
+
+/**
+ * Create the empty value placeholder text
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.3.0
+ * @version  0.3.0
+ *
+ * @return   {string|HTMLElement|Microcopy}
+ */
+Field.setMethod(function createEmptyValuePlaceholderText() {
+
+	let microcopy = this.applied_options?.empty_value_placeholder;
+
+	if (microcopy) {
+		return microcopy;
+	}
+
+	microcopy = Classes.Alchemy.Microcopy('empty-value-placeholder', {
+		field_name : this.field_name,
+		model_name : this.model,
+		field_type : this.field_type,
+		zone       : this.zone,
+		path       : this.config?.path_in_document,
+	});
+
+	return microcopy;
+});
+
+/**
+ * Get variables needed to render this
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.3.0
+ * @version  0.3.0
+ */
+Field.setMethod(function prepareRenderVariables() {
+
+	let value = this.value_to_render,
+	    value_is_empty = value == null || value === '' || (Array.isArray(value) ? value.length == 0 : false);
+
+	let result = {
+		alchemy_field  : this,
+		field_context  : this,
+		view_files     : this.view_files,
+		wrapper_files  : this.wrapper_files,
+		value,
+		value_is_empty,
+	};
+
+	return result;
+});
+
 /**
  * Apply options
+ * (Like options from a FieldConfig instance)
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.12
@@ -1043,32 +1121,19 @@ Field.setMethod(async function loadData(config, element) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.9
- * @version  0.2.10
+ * @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.getValueAsDocument();
-				}
+	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];

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;
 	}
 

package/element/al_settings_editor.js

@@ -0,0 +1,367 @@
+/**
+ * The settings editor
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.3.0
+ * @version  0.3.0
+ */
+const SettingsEditor = Function.inherits('Alchemy.Element.Form.Base', 'SettingsEditor');
+
+/**
+ * The template to use for the content of this element
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.3.0
+ * @version  0.3.0
+ */
+SettingsEditor.setTemplateFile('form/elements/al_settings_editor');
+
+/**
+ * The actual settings and their values
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.3.0
+ * @version  0.3.0
+ */
+SettingsEditor.setAssignedProperty('settings_config');
+
+/**
+ * Address to send updates t
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.3.0
+ * @version  0.3.0
+ */
+SettingsEditor.setAttribute('src');
+
+/**
+ * Get the current value
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ */
+SettingsEditor.setProperty(function value() {
+
+	let result = {};
+
+	let root_key,
+	    elements = this.querySelectorAll('.al-settings-setting'),
+	    element,
+	    field,
+	    i;
+
+	for (i = 0; i < elements.length; i++) {
+		element = elements[i];
+
+		field = element.querySelector('al-field');
+
+		if (!field) {
+			continue;
+		}
+
+		if (!root_key) {
+			root_key = element.dataset.id.split('.')[0];
+		}
+
+		Object.setPath(result, element.dataset.id, field.value);
+	}
+
+	return result[root_key];
+});
+
+/**
+ * Populate the settings container
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ */
+SettingsEditor.setMethod(function populateSettingsContainer(container) {
+
+	if (!container) {
+		container = this.querySelector('.al-settings-container');
+	}
+
+	Hawkejs.removeChildren(container);
+
+	this._addGroupToContainer(container, this.settings_config);
+});
+
+/**
+ * Create an id
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ *
+ * @param    {string}   suffix
+ *
+ * @return   {string}
+ */
+SettingsEditor.setMethod(function createId(suffix) {
+
+	let id = this.id;
+
+	if (!id) {
+		id = 'settings-editor';
+	}
+
+	id += '-' + suffix.slug().underscore();
+
+	return id;
+});
+
+/**
+ * Add the given group to the container
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ *
+ * @param    {HTMLElement}   container
+ * @param    {Object}        group
+ */
+SettingsEditor.setMethod(function _addGroupToContainer(container, group) {
+
+	if (!group) {
+		return;
+	}
+
+	if (!container) {
+		throw new Error('No container given');
+	}
+
+	let add_group = false;
+
+	if (group.settings?.length) {
+		add_group = true;
+	} else if (group.children?.length) {
+		// If the root group has no settings, don't add it
+		if (!group.is_root) {
+			add_group = true;
+		}
+	}
+
+	if (add_group) {
+		let group_element = this.createElement('div');
+		group_element.classList.add('al-settings-group');
+		group_element.dataset.id = group.group_id;
+		group_element.id = this.createId(group.group_id);
+
+		let header_element = this.createElement('header');
+		header_element.classList.add('al-settings-group-header');
+
+		let title_element = this.createElement('div');
+		title_element.classList.add('al-settings-group-title');
+		title_element.dataset.toc_level = group.group_id.count('.');
+
+		let group_title_microcopy = this.createElement('micro-copy');
+		group_title_microcopy.key = 'settings.title.group:' + group.group_id;
+		group_title_microcopy.fallback = group.name.titleize();
+
+		title_element.append(group_title_microcopy);
+		header_element.append(title_element);
+		group_element.append(header_element);
+
+		let settings_container = this.createElement('div');
+		settings_container.classList.add('al-settings-settings-container');
+
+		for (let setting of group.settings) {
+			this._addSettingToGroupElement(settings_container, setting);
+		}
+
+		group_element.append(settings_container);
+		container.append(group_element);
+	}
+
+	for (let child_group of group.children) {
+		this._addGroupToContainer(container, child_group);
+	}
+});
+
+/**
+ * Add the given setting to the container
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ *
+ * @param    {HTMLElement}   settings_container_element
+ * @param    {Object}        setting
+ */
+SettingsEditor.setMethod(function _addSettingToGroupElement(settings_container_element, setting) {
+
+	if (!setting?.schema) {
+		return;
+	}
+
+	let value_field = setting.schema.get('value');
+
+	if (!value_field) {
+		return;
+	}
+
+	let settings_element = this.createElement('div');
+
+	let id = this.createId(setting.setting_id);
+
+	// Set the IDs
+	settings_element.dataset.id = setting.setting_id;
+	settings_element.id = id;
+
+	// Add the CSS class
+	settings_element.classList.add('al-settings-setting');
+
+	// Create the title element
+	let header_element = this.createElement('header');
+	header_element.classList.add('al-settings-setting-header');
+
+	let title_element = this.createElement('div');
+	title_element.classList.add('al-settings-setting-title');
+
+	let title_microcopy = this.createElement('micro-copy');
+	title_microcopy.key = 'settings.title:' + setting.setting_id;
+	title_microcopy.fallback = setting.name.titleize();
+
+	header_element.append(title_element);
+	title_element.append(title_microcopy);
+
+	if (setting.show_description !== false) {
+		let description_element = this.createElement('div');
+		description_element.classList.add('al-settings-setting-description');
+
+		let description_microcopy = this.createElement('micro-copy');
+		description_microcopy.key = 'settings.description:' + setting.setting_id;
+		description_microcopy.fallback = setting.description || '';
+
+		header_element.append(description_element);
+		description_element.append(description_microcopy);
+	}
+
+	settings_element.append(header_element);
+
+	let input_wrapper = this.createElement('div');
+	
+	let al_field = this.createElement('al-field');
+	al_field.id = 'af-' + id;
+	al_field.config = value_field;
+	al_field.value = setting.current_value;
+	al_field.mode = 'inline';
+
+	this.hawkejs_view.registerElementInstance(al_field);
+
+	if (setting.locked) {
+		al_field.readonly = true;
+	}
+
+	input_wrapper.append(al_field);
+
+	settings_element.append(input_wrapper);
+
+	settings_container_element.append(settings_element);
+});
+
+/**
+ * This element has been added to the DOM for the first time
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ */
+SettingsEditor.setMethod(function introduced() {
+
+	let save_button = this.querySelector('.save-changes');
+
+	save_button.addEventListener('activate', async e => {
+
+		let old_state = save_button.state;
+
+		save_button.setState('saving');
+
+		try {
+			await this.save();
+		} catch (err) {
+			save_button.setState('error', 2500, old_state);
+			return;
+		}
+
+		save_button.setState('saved', 1000, old_state);
+	});
+
+	save_button.hidden = !this.src;
+});
+
+/**
+ * Get the changes
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ */
+SettingsEditor.setMethod(function getChanges() {
+
+	let result = {};
+
+	let new_value,
+	    original_value,
+	    elements = this.querySelectorAll('.al-settings-setting'),
+	    element,
+	    field,
+	    i;
+
+	for (i = 0; i < elements.length; i++) {
+		element = elements[i];
+
+		field = element.querySelector('al-field');
+
+		if (!field) {
+			continue;
+		}
+
+		new_value = field.value;
+		original_value = field.original_value;
+
+		if (Object.alike(new_value, original_value) || new_value == original_value) {
+			continue;
+		}
+
+		// Ignore empty values that were not set before
+		if (new_value === '' && original_value == null) {
+			continue;
+		}
+
+		// Ignore empty values that were not set before
+		if (new_value === false && original_value == null) {
+			continue;
+		}
+
+		result[element.dataset.id] = new_value;
+	}
+
+	return result;
+});
+
+/**
+ * Save the changes
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.0
+ * @version  1.3.0
+ */
+SettingsEditor.setMethod(async function save() {
+
+	if (!this.src) {
+		return;
+	}
+
+	let changes = this.getChanges();
+
+	let result;
+
+	try {
+		result = await alchemy.fetch(this.src, {post: changes});
+	} catch (err) {
+		throw err;
+	}
+});

package/element/al_table.js

@@ -597,7 +597,7 @@ Table.setMethod(function showPagination() {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.8
- * @version  0.2.0
+ * @version  0.3.0
  *
  * @param    {FieldConfig}   field_config   The config on how to display the field
  * @param    {Object}        container      The container where the field should be in
@@ -640,6 +640,7 @@ Table.setMethod(function getFieldConfigView(field_config, container) {
 	alchemy_field.field_name = field.name;
 	alchemy_field.config = field;
 	alchemy_field.original_value = value;
+	alchemy_field.model = field?.schema?.model_name;
 
 	return alchemy_field;
 });
@@ -677,7 +678,7 @@ Table.setMethod(function addDataRow(entry) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.2.0
+ * @version  0.3.0
  *
  * @param    {Object}   entry
  *
@@ -705,6 +706,10 @@ Table.setMethod(function createDataRow(entry) {
 		tr.dataset.pk = id;
 	}
 
+	if (!this.fieldset) {
+		throw new Error('No fieldset has been defined for this table yet');
+	}
+
 	for (field_set_config of this.fieldset) {
 
 		let create_new_contents = true,
@@ -907,7 +912,7 @@ Table.setMethod(function attachContextMenus() {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.1.12
+ * @version  0.3.0
  */
 Table.setMethod(function onFieldsetAssignment(value, old_value) {
 
@@ -935,7 +940,7 @@ Table.setMethod(function onFieldsetAssignment(value, old_value) {
 	}
 
 	for (field of value) {
-		col = this.createElement('td');
+		col = this.createElement('th');
 		span = this.createElement('span');
 		span.textContent = field.title;
 
@@ -980,10 +985,10 @@ Table.setMethod(function onFieldsetAssignment(value, old_value) {
 	}
 
 	if (this.has_actions) {
-		col = this.createElement('td');
+		col = this.createElement('th');
 		names_row.append(col);
 
-		col = this.createElement('td');
+		col = this.createElement('th');
 		filter_row.append(col);
 	}
 

package/package.json

@@ -1,14 +1,15 @@
 {
 	"name": "alchemy-form",
 	"description": "Form plugin for Alchemy",
-	"version": "0.2.10",
+	"version": "0.3.0-alpha.2",
 	"repository": {
 		"type" : "git",
 		"url"  : "https://github.com/11ways/alchemy-form.git"
 	},
 	"peerDependencies": {
-		"alchemymvc"    : ">=1.3.0",
-		"alchemy-media" : ">=0.7.6"
+		"alchemymvc"    : ">=1.4.0||>=1.4.0-alpha",
+		"alchemy-media" : ">=0.9.0||>=0.9.0-alpha",
+		"alchemy-styleboost": ">=0.5.0||>=0.5.0-alpha"
 	},
 	"license": "MIT",
 	"engines": {

package/view/form/elements/al_settings_editor.hwk

@@ -0,0 +1,36 @@
+<div class="al-settings-sidebar">
+	<al-toc
+		container-element="ul"
+		entry-element="li"
+		parent-selector="al-settings-editor"
+		children-selector=".al-settings-container"
+		elements-selector=".al-settings-group"
+		title-selector=".al-settings-group-title"
+	></al-toc>
+</div>
+<div class="al-settings-main">
+	<div class="al-settings-container"><% self.populateSettingsContainer($0) %></div>
+	<div class="al-settings-actions">
+		<al-button class="save-changes" state="ready" hidden>
+			<al-state state-name="saving">
+				<al-icon icon-style="duotone" icon-name="spinner" icon-flags="spin"></al-icon>
+				{%t "saving" %}
+			</al-state>
+
+			<al-state state-name="saved">
+				<al-icon icon-style="duotone" icon-name="badge-check" icon-flags="beat"></al-icon>
+				{%t "saved" %}
+			</al-state>
+
+			<al-state state-name="error">
+				<al-icon icon-style="duotone" icon-name="skull" icon-flags="shake"></al-icon>
+				{%t "error" action="save" %}
+			</al-state>
+
+			<al-state state-name="ready">
+				<al-icon icon-style="duotone" icon-name="floppy-disk-circle-arrow-right"></al-icon>
+				{%t "save" %}
+			</al-state>
+		</al-button>
+	</div>
+</div>

package/view/form/elements/alchemy_field.hwk

@@ -1,16 +1,5 @@
-<% wrapper_files = self.wrapper_files %>
-<% view_files = self.view_files %>
-<%
-variables = {
-	alchemy_field : self,
-	field_context : self,
-	view_files    : view_files,
-	value         : self.value_to_render,
-}
-%>
-
 <% if (wrapper_files) { %>
-	<% include(wrapper_files, variables) %>
+	<% include(wrapper_files) %>
 <% } %>
 
 <% if (wrapper_files) start('field') %>

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

@@ -0,0 +1,9 @@
+<al-code-input
+	class="alchemy-field-value"
+	form=<% form_id %>
+	name=<% path %>
+	placeholder={% alchemy_field.placeholder %}
+	language-mode="json"
+	value-is-object
+	#value={% value %}
+></al-code-input>