pict-section-form 1.0.158 → 1.0.159

package/example_applications/complex_table/Complex-Tabular-Application.js

@@ -86,7 +86,8 @@ module.exports.default_configuration.pict_configuration = {
 						"RecipeCounterSurfaceArea = RecipeCounterWidth * RecipeCounterDepth",
 						"RecipeCounterVolume = RecipeCounterSurfaceArea * RecipeVerticalClearance",
 						`InspirationLink = CONCAT("https://www.google.com/search?q=", RecipeName, " recipe")`,
-						'cumulativeSummationResult = cumulativeSummation(getvalue("AppData.FruitData.FruityVice"), "nutritions.calories", "SummedCalories")'
+						'cumulativeSummationResult = cumulativeSummation(getvalue("AppData.FruitData.FruityVice"), "nutritions.calories", "SummedCalories")',
+						`MAP VAR row FROM FruitData.FruityVice : ColorInputBackgroundTabular("FruitGrid", "FruitGrid", "PercentTotalFat", stepIndex, "#FFCCCC", IF(row.nutritions.percent_total_fat, ">", 0.25, 1, 0))`,
 					],
 
 				MetaTemplates:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pict-section-form",
-    "version": "1.0.158",
+    "version": "1.0.159",
     "description": "Pict dynamic form sections",
     "main": "source/Pict-Section-Form.js",
     "directories": {
@@ -34,7 +34,7 @@
         "browser-env": "^3.3.0",
         "eslint": "^9.39.1",
         "jquery": "^3.7.1",
-        "pict": "^1.0.334",
+        "pict": "^1.0.337",
         "pict-application": "^1.0.29",
         "pict-service-commandlineutility": "^1.0.16",
         "quackage": "^1.0.45",

package/source/providers/Pict-Provider-DynamicFormSolverBehaviors.js

@@ -82,6 +82,7 @@ class PictDynamicFormsSolverBehaviors extends libPictProvider
 		this.addSolverFunction(pExpressionParser, 'colorSectionBackground', 'fable.providers.DynamicFormSolverBehaviors.colorSectionBackground', 'Colors a section background with a HTML hex color (e.g. #FF0000 for red).');
 		this.addSolverFunction(pExpressionParser, 'colorGroupBackground', 'fable.providers.DynamicFormSolverBehaviors.colorGroupBackground', 'Colors a group background with a HTML hex color (e.g. #FF0000 for red).');
 		this.addSolverFunction(pExpressionParser, 'colorInputBackground', 'fable.providers.DynamicFormSolverBehaviors.colorInputBackground', 'Colors an input background with a HTML hex color (e.g. #FF0000 for red).');
+		this.addSolverFunction(pExpressionParser, 'colorInputBackgroundTabular', 'fable.providers.DynamicFormSolverBehaviors.colorInputBackgroundTabular', 'Colors a tabular input background with a HTML hex color (e.g. #FF0000 for red).');
 
 		return false;
 	}
@@ -293,7 +294,8 @@ class PictDynamicFormsSolverBehaviors extends libPictProvider
 			return true;
 		}
 
-		let tmpInputView = this.pict.views.PictFormMetacontroller.getSectionViewFromHash(pSectionHash)
+		/** @type {import('../views/Pict-View-DynamicForm.js')} */
+		let tmpInputView = this.pict.views.PictFormMetacontroller.getSectionViewFromHash(pSectionHash);
 
 		if (!tmpInputView)
 		{
@@ -313,22 +315,89 @@ class PictDynamicFormsSolverBehaviors extends libPictProvider
 
 		if (tmpElementSet.length < 1)
 		{
-			this.log.warn(`PictDynamicFormsInformary: colorInput could not find input element with section hash [${pSectionHash}] input [${pInputHash}] selector [${ tmpElementSet[0].id}].`);
+			this.log.warn(`PictDynamicFormsInformary: colorInput could not find input element with section hash [${pSectionHash}] input [${pInputHash}] selector [#${tmpInput.Macro.RawHTMLID}].`);
 			return false;
 		}
 
-		let tmpElement = tmpElementSet[0];
+		return this.colorElementBackground(tmpElementSet, pColor, pCSSSelector);
+	}
+
+	/**
+	 * Colors an input background or its container with a HTML hex color (e.g. #FF0000 for red).
+	 * @param {string} pSectionHash - The hash of the section containing the input.
+	 * @param {string} pGroupHash - The hash of the group containing the input.
+	 * @param {number} pRowIndex - The index of the row.
+	 * @param {string} pInputHash - The hash of the input to color.
+	 * @param {string} pColor - The HTML hex color to apply (e.g. #FF0000 for red).
+	 * @param {string} pApplyChange - If "0", the change will not be applied.
+	 * @param {string} [pCSSSelector] - Optional. If provided, the color will be applied to the closest element matching this selector instead of the input itself.
+	 * @param {string} [pElementIDPrefix] - Optional. The prefix for the tabular element ID. Default is 'TABULAR-DATA-'.
+	 * @returns {boolean} - Returns true if the color was applied successfully or if the change was skipped for pApplyChange equal to "0", false otherwise.
+	 */
+	colorInputBackgroundTabular(pSectionHash, pGroupHash, pInputHash, pRowIndex, pColor, pApplyChange, pCSSSelector, pElementIDPrefix = 'TABULAR-DATA-')
+	{
+		if (pApplyChange == "0")
+		{
+			return true;
+		}
+
+		/** @type {import('../views/Pict-View-DynamicForm.js')} */
+		let tmpInputView = this.pict.views.PictFormMetacontroller.getSectionViewFromHash(pSectionHash);
+
+		if (!tmpInputView)
+		{
+			this.log.warn(`PictDynamicFormsInformary: colorInputBackgroundTabular could not find input with section hash [${pSectionHash}] group hash [${pGroupHash}] input hash [${pInputHash}].`);
+			return false;
+		}
+
+		let tmpInput = tmpInputView.getTabularRecordInputByHash(pGroupHash, pInputHash);
+
+		if (!tmpInput)
+		{
+			this.log.warn(`PictDynamicFormsInformary: colorInputBackgroundTabular could not find input with section hash [${pSectionHash}] group hash [${pGroupHash}] input hash [${pInputHash}].`);
+			return false;
+		}
+
+		if (!tmpInput.Macro)
+		{
+			this.log.warn(`PictDynamicFormsInformary: colorInputBackgroundTabular input with section hash [${pSectionHash}] group hash [${pGroupHash}] input hash [${pInputHash}] is missing Macro data.`);
+			return false;
+		}
+
+		//FIXME: is this reliable for all input types?
+		let tmpElementSet = this.pict.ContentAssignment.getElement(`#${pElementIDPrefix}${tmpInput.Macro.RawHTMLID}-${pRowIndex}`);
+
+		if (tmpElementSet.length < 1)
+		{
+			this.log.warn(`PictDynamicFormsInformary: colorInputBackgroundTabular could not find input element with section hash [${pSectionHash}] group hash [${pGroupHash}] input hash [${pInputHash}] row index [${pRowIndex}] selector [#${tmpInput.Macro.RawHTMLID}-${pRowIndex}].`);
+			return false;
+		}
+
+		return this.colorElementBackground(tmpElementSet, pColor, pCSSSelector);
+	}
+
+	/**
+	 * @param {Array<HTMLElement>} pElementSet - The element to color.
+	 * @param {string} pColor - The HTML hex color to apply (e.g. #FF0000 for red).
+	 * @param {string} [pCSSSelector] - Optional. If provided, the color will be applied to the closest element matching this selector instead of the input itself.
+	 *
+	 * @returns {boolean}
+	 */
+	colorElementBackground(pElementSet, pColor, pCSSSelector)
+	{
+		/** @type {HTMLElement} */
+		let tmpElement = pElementSet[0];
 
 		// if we passed a class target, find the closest element with that class and apply the color to it
 		// otherwise, just apply it to the input element itself
 		if (pCSSSelector)
 		{
 			// find closest target by class name and if we find it, immediately break out of the loop
-			for (let i = 0; i < tmpElementSet.length; i++)
+			for (let i = 0; i < pElementSet.length; i++)
 			{
-				const element = tmpElementSet[i];
+				const element = pElementSet[i];
 				const closest = element.closest(`${pCSSSelector}`);
-				if (closest)
+				if (closest && closest instanceof HTMLElement)
 				{
 					tmpElement = closest;
 					break;

package/source/providers/Pict-Provider-DynamicTabularData.js

@@ -78,7 +78,7 @@ class DynamicTabularData extends libPictProvider
 
 		if (!tmpGroup)
 		{
-			this.log.warn(`PICT View Metatemplate Helper getTabularRowData ${pGroupIndex} was not a valid group.`);
+			this.log.warn(`PICT View Metatemplate Helper getTabularRecordInput ${pGroupIndex} was not a valid group.`);
 			return false;
 		}
 
@@ -88,6 +88,45 @@ class DynamicTabularData extends libPictProvider
 		return tmpGroup.supportingManifest.elementDescriptors[tmpSupportingManifestHash];
 	}
 
+	/**
+	 * Retrieves the tabular record input from the specified view, group, and input indexes.
+	 *
+	 * @param {Object} pView - The view object.
+	 * @param {number} pGroupHash - The index of the group.
+	 * @param {number} pInputHash - The index of the input.
+	 * @returns {ElementDescriptor|boolean} The tabular record input or false if the group is invalid.
+	 */
+	getTabularRecordInputByHash(pView, pGroupHash, pInputHash)
+	{
+		// The neat thing about how the tabular groups work is that we can make it clever about whether it's an object or an array.
+		let tmpGroup = pView.getGroups().find((pGroup) => pGroup.Hash === pGroupHash);
+
+		if (!tmpGroup)
+		{
+			this.log.warn(`PICT View Metatemplate Helper getTabularRecordInputByHash ${pGroupHash} was not a valid group.`);
+			return false;
+		}
+
+		if (!tmpGroup.supportingManifest)
+		{
+			this.log.warn(`PICT View Metatemplate Helper getTabularRecordInputByHash ${pGroupHash} s not a tabular group.`);
+			return false;
+		}
+
+		// Now get the supporting manifest and the input element
+		// This needs more guards
+		for (const tmpDescriptor of Object.values(tmpGroup.supportingManifest.elementDescriptors))
+		{
+			if (tmpDescriptor.Hash === pInputHash)
+			{
+				return tmpDescriptor;
+			}
+		}
+
+		this.log.warn(`PICT View Metatemplate Helper getTabularRecordInputByHash ${pGroupHash} could not find input ${pInputHash}.`);
+		return false;
+	}
+
 	/**
 	 * Retrieves tabular record data based on the provided parameters.
 	 *
@@ -103,7 +142,7 @@ class DynamicTabularData extends libPictProvider
 
 		if (!tmpGroup)
 		{
-			this.log.warn(`PICT View Metatemplate Helper getTabularRowData ${pGroupIndex} was not a valid group.`);
+			this.log.warn(`PICT View Metatemplate Helper getTabularRecordData ${pGroupIndex} was not a valid group.`);
 			return false;
 		}
 
@@ -118,7 +157,7 @@ class DynamicTabularData extends libPictProvider
 
 		if (!tmpRowSourceRecord)
 		{
-			this.log.warn(`PICT View Metatemplate Helper getTabularRowData ${pGroupIndex} could not find the record set for ${tmpGroup.RecordSetAddress}.`);
+			this.log.warn(`PICT View Metatemplate Helper getTabularRecordData ${pGroupIndex} could not find the record set for ${tmpGroup.RecordSetAddress}.`);
 			return false;
 		}
 
@@ -135,13 +174,13 @@ class DynamicTabularData extends libPictProvider
 			}
 			else
 			{
-				this.log.warn(`PICT View Metatemplate Helper getTabularRowData ${pGroupIndex} could not determine the type of the record set for ${tmpGroup.RecordSetAddress}.`);
+				this.log.warn(`PICT View Metatemplate Helper getTabularRecordData ${pGroupIndex} could not determine the type of the record set for ${tmpGroup.RecordSetAddress}.`);
 				return false;
 			}
 		}
 		catch (pError)
 		{
-			this.log.error(`PICT View Metatemplate Helper getTabularRowData ${pGroupIndex} encountered an error: ${pError}`);
+			this.log.error(`PICT View Metatemplate Helper getTabularRecordData ${pGroupIndex} encountered an error: ${pError}`);
 			return false;
 		}
 	}

package/source/providers/inputs/Pict-Provider-Input-PreciseNumber.js

@@ -91,7 +91,7 @@ class CustomInputHandler extends libPictSectionInputExtension
 	 */
 	onDataMarshalToFormTabular(pView, pGroup, pInput, pValue, pHTMLSelector, pRowIndex, pTransactionGUID)
 	{
-		this.pict.ContentAssignment.assignContent('PRECISE-' + this.getTabularInputHTMLID(pInput.Macro.RawHTMLID, pRowIndex), pValue);
+		this.pict.ContentAssignment.assignContent('#PRECISE-' + this.getTabularInputHTMLID(pInput.Macro.RawHTMLID, pRowIndex).substring(1), pValue);
 		this.pict.ContentAssignment.assignContent(this.getTabularInputHTMLID(pInput.Macro.RawHTMLID, pRowIndex), this.roundValue(pInput, pValue));
 		return super.onDataMarshalToFormTabular(pView, pGroup, pInput, pValue, pHTMLSelector, pRowIndex, pTransactionGUID);
 	}

package/source/services/ManifestFactory.js

@@ -875,7 +875,7 @@ class ManifestFactory extends libFableServiceProviderBase
 					{
 						tmpDescriptorManifest.setValueAtAddress(tmpDescriptor, tmpAddress, tmpValue);
 					}
-					else
+					else if (tmpRawValue)
 					{
 						this.log.warn(`Could not parse Boolean value [${tmpRawValue}] for Descriptor Boolean Extension [${tmpKey}] on descriptor [${tmpDescriptor.Hash}]`);
 					}

package/source/views/Pict-View-DynamicForm.js

@@ -1369,6 +1369,21 @@ class PictViewDynamicForm extends libPictViewClass
 		return this.pict.providers.DynamicTabularData.getTabularRecordInput(this, pGroupIndex, pInputIndex);
 	}
 
+	/**
+	 * Get the input object for a specific tabular record group and index.
+	 *
+	 * Input objects are not distinct among rows.
+	 *
+	 * @param {string} pGroupHash - The hash of the group.
+	 * @param {string} pInputHash - The hash of the input.
+	 *
+	 * @return {Object} The input object.
+	 */
+	getTabularRecordInputByHash(pGroupHash, pInputHash)
+	{
+		return this.pict.providers.DynamicTabularData.getTabularRecordInputByHash(this, pGroupHash, pInputHash);
+	}
+
 	/**
 	 * Get the tabular record object for a particular row in a group.
 	 *