mod-build 4.0.100-beta.4 → 4.0.100

package/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 4.0.100
 
-- Refactored `get-default-trade-questions.js` to reduce duplicated logic in `lead-form` and enable reuse across instances.
+- Added field-level `move` support in `get-default-trade-questions` (e.g. `move: [{ from: 3, to: 0 }]`) to reorder default options while merging
 
 ## 4.0.99
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mod-build",
-	"version": "4.0.100-beta.4",
+	"version": "4.0.100",
 	"description": "Share components for S3 sites.",
 	"type": "module",
 	"scripts": {

package/tasks/get-default-trade-questions.js

@@ -2,7 +2,7 @@
 import merge from 'lodash.merge';
 import { defaultSettings } from '../src/data/config.js';
 
-export function resolveRefs(value, root = value, refChain = new Set()) {
+function resolveRefs(value, root, refChain = new Set()) {
 	if (value === null || typeof value !== 'object') {
 		return value;
 	}
@@ -33,137 +33,184 @@ export function resolveRefs(value, root = value, refChain = new Set()) {
 	return resolved;
 }
 
-function mergeQuestionFields(fields, defaultFields, {
-	legendAttributes,
-	optionFieldTypes,
-	errorMessages
-}) {
-	let defaultOptions = [];
-	let defaultLegend = {};
-	defaultFields.forEach((defaultField) => {
-		defaultOptions = defaultField.options;
-		defaultLegend = defaultField.legend;
-
-		if (defaultLegend && legendAttributes) {
-			defaultLegend.attributes = {
-				...defaultLegend.attributes,
-				...legendAttributes
-			};
-		}
-	});
-
-	fields.forEach((field) => {
-		if (field.legend) {
-			field.legend = merge(defaultLegend, field.legend);
-		} else {
-			field.legend = defaultLegend;
-		}
-
-		if (field.remove) {
-			if (field.remove.includes('all')) {
-				defaultOptions = [];
-			} else {
-				defaultOptions = defaultOptions.filter((_, index) => !field.remove.includes(index));
-			}
-		}
-
-		if (!optionFieldTypes.includes(field.fieldType)) {
-			return;
-		}
-
-		if (!field.errorMessage && errorMessages[field.fieldType]) {
-			field.errorMessage = errorMessages[field.fieldType];
-		}
-
-		if (Array.isArray(field.options)) {
-			field.options.forEach((option) => {
-				if (typeof option.update === 'number') {
-					if (option.attributes?.checked === false) {
-						delete option.attributes.checked;
-						delete defaultOptions[option.update]?.attributes?.checked;
-					}
-					merge(defaultOptions[option.update], option);
-				} else if (typeof option.insertAt === 'number') {
-					defaultOptions.splice(option.insertAt, 0, option);
-				} else {
-					defaultOptions.push(option);
-				}
-			});
-		}
-		field.options = defaultOptions;
-	});
-}
-
-export function mergeDefaultTradeQuestionsIntoItems(items, steps, options = {}) {
-	if (!Array.isArray(items) || !steps || typeof steps !== 'object') {
-		return;
-	}
-
-	const mergeOptions = {
-		legendAttributes: options.legendAttributes,
-		optionFieldTypes: options.optionFieldTypes || ['radio', 'checkbox-group'],
-		errorMessages: {
-			radio: 'Professionals need this info to generate a quote.',
-			'checkbox-group': 'Please select at least one option.',
-			...options.errorMessages
-		}
-	};
-
-	items.forEach((item) => {
-		const stepName = item.attributes?.data?.['step-name'];
-		const defaultStep = steps[stepName];
-		if (!defaultStep) {
-			return;
-		}
-
-		if (!item.stepContent) {
-			item.stepContent = {};
-		}
-		if (!item.stepContent.fields) {
-			item.stepContent.fields = [];
-		}
-
-		mergeQuestionFields(item.stepContent.fields, defaultStep.fields, mergeOptions);
-
-		const extraQuestionBlock = item.stepContent.extraQuestionBlock;
-		if (extraQuestionBlock) {
-			if (!extraQuestionBlock.fields) {
-				extraQuestionBlock.fields = [];
-			}
-			mergeQuestionFields(
-				extraQuestionBlock.fields,
-				defaultStep.extraQuestionBlock.fields,
-				mergeOptions
-			);
-		}
-	});
-}
-
-export function mergeDefaultTradeQuestionsConfigOnSteps(config, steps, options) {
+function mergeDefaultTradeQuestionsConfigOnSteps(config, steps) {
 	if (!config || typeof config !== 'object') return;
 
 	if (config.steps && typeof config.steps === 'object' && config.steps.items) {
 		// cloning steps to keep multiple steps: {} objects independent
 		const clonedSteps = JSON.parse(JSON.stringify(steps));
-		mergeDefaultTradeQuestionsConfig(config, clonedSteps, options);
+		mergeDefaultTradeQuestionsConfig(config, clonedSteps);
 	}
 
 	for (const key in config) {
 		if (config.hasOwnProperty(key)) {
 			const value = config[key];
 			if (typeof value === 'object' && value !== null) {
-				mergeDefaultTradeQuestionsConfigOnSteps(value, steps, options);
+				mergeDefaultTradeQuestionsConfigOnSteps(value, steps);
 			}
 		}
 	}
 }
 
-export function mergeDefaultTradeQuestionsConfig(config, steps, options) {
+function mergeDefaultTradeQuestionsConfig(config, steps) {
 	if (!config || !config.steps || !config.steps.items || !Array.isArray(config.steps.items)) {
 		return;
 	}
 
-	mergeDefaultTradeQuestionsIntoItems(config.steps.items, steps, options);
+	config.steps.items.forEach((item) => {
+		const stepName = item.attributes.data['step-name'];
+		if (steps[stepName]) {
+			if (!item.stepContent) {
+				item.stepContent = {};
+			}
+
+			if (!item.stepContent.fields) {
+				item.stepContent.fields = [];
+			}
+			const defaultStepFields = steps[stepName].fields;
+			let defaultStepOptions = [];
+			let defaultQuestionLegend = {};
+			defaultStepFields.forEach((defaultField) => {
+				defaultStepOptions = defaultField.options;
+				defaultQuestionLegend = defaultField.legend;
+			});
+
+			item.stepContent.fields.forEach((field) => {
+				if (field.legend) {
+					field.legend = merge(defaultQuestionLegend, field.legend);
+				} else {
+					field.legend = defaultQuestionLegend;
+				}
+
+				if (field && field.remove) {
+					if (field.remove.includes('all')) {
+						defaultStepOptions = [];
+					} else {
+						defaultStepOptions = defaultStepOptions.filter((_, i) => !field.remove.includes(i));
+					}
+				}
+
+				if (field && field.move) {
+					// field.move will look like [{from: 0, to: 1}]
+					// we need to remove option at from index and insert at to index
+					field.move.forEach((move) => {
+						const fromIndex = move.from;
+						const toIndex = move.to;
+						const fromOption = defaultStepOptions.splice(fromIndex, 1);
+						defaultStepOptions.splice(toIndex, 0, fromOption[0]);
+					});
+				}
+
+				if (field.fieldType === 'radio' || field.fieldType === 'checkbox-group') {
+					if (!field.errorMessage) {
+						field.errorMessage = field.fieldType === 'checkbox-group' ? 'Please select at least one option.' : 'Professionals need this info to generate a quote.';
+					}
+
+					if (field.options && Array.isArray(field.options) && field.options.length) {
+						field.options.forEach((option) => {
+							if (typeof option.update === 'number') {
+								if (option.attributes && option.attributes.checked === false) {
+									delete option.attributes.checked;
+									delete defaultStepOptions[option.update].attributes.checked;
+								}
+								merge(defaultStepOptions[option.update], option);
+							} else {
+								if (typeof option.insertAt === 'number') {
+									defaultStepOptions.splice(option.insertAt, 0, option);
+								} else {
+									defaultStepOptions.push(option);
+								}
+							}
+						});
+					}
+					field.options = defaultStepOptions;
+				} else {
+					if (field && Array.isArray(field) && field.length) {
+						if (typeof field.update === 'number') {
+							merge(defaultStepFields[field.update], field);
+						} else {
+							if (typeof field.insertAt === 'number') {
+								defaultStepFields.splice(field.insertAt, 0, field);
+							} else {
+								defaultStepFields.push(field);
+							}
+						}
+					}
+
+					field = defaultStepFields;
+				}
+			});
+
+			// extra question block
+			if (item.stepContent.extraQuestionBlock) {
+				if (!item.stepContent.extraQuestionBlock.fields) {
+					item.stepContent.extraQuestionBlock.fields = [];
+				}
+
+				const defaultExtraQuestionFields = steps[stepName].extraQuestionBlock.fields;
+				let defaultExtraQuestionOptions = [];
+				let defaultExtraQuestionLegend = {};
+				defaultExtraQuestionFields.forEach((defaultExtraQuestionField) => {
+					defaultExtraQuestionOptions = defaultExtraQuestionField.options;
+					defaultExtraQuestionLegend = defaultExtraQuestionField.legend;
+				});
+				item.stepContent.extraQuestionBlock.fields.forEach((field) => {
+
+					if (field.legend) {
+						field.legend = merge(defaultExtraQuestionLegend, field.legend);
+					} else {
+						field.legend = defaultExtraQuestionLegend;
+					}
+
+					if (field && field.remove) {
+						if (field.remove.includes('all')) {
+							defaultExtraQuestionOptions = [];
+						} else {
+							defaultExtraQuestionOptions = defaultExtraQuestionOptions.filter((_, i) => !field.remove.includes(i));
+						}
+					}
+
+					if (field.fieldType === 'radio') {
+						if (!field.errorMessage) {
+							field.errorMessage = 'Professionals need this info to generate a quote.';
+						}
+
+						if (field.options && Array.isArray(field.options) && field.options.length) {
+							field.options.forEach((option, optionIndex) => {
+								if (typeof option.update === 'number') {
+									if (option.attributes && option.attributes.checked === false) {
+										delete option.attributes.checked;
+										delete defaultStepOptions[option.update].attributes.checked;
+									}
+									merge(defaultExtraQuestionOptions[option.update], option);
+								} else {
+									if (typeof option.insertAt === 'number') {
+										defaultExtraQuestionOptions.splice(option.insertAt, 0, option);
+									} else {
+										defaultExtraQuestionOptions.push(option);
+									}
+								}
+							});
+						}
+						field.options = defaultExtraQuestionOptions;
+					} else {
+						if (field && Array.isArray(field) && field.length) {
+							if (typeof field.update === 'number') {
+								merge(defaultExtraQuestionFields[field.update], field);
+							} else {
+								if (typeof field.insertAt === 'number') {
+									defaultExtraQuestionFields.splice(field.insertAt, 0, field);
+								} else {
+									defaultExtraQuestionFields.push(field);
+								}
+							}
+						}
+						field = defaultExtraQuestionFields;
+					}
+				});
+			}
+		}
+	});
 }
 
 export default async function(config) {