pict-section-form 1.0.13 → 1.0.15

package/eslint.config.mjs

@@ -0,0 +1,10 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+
+
+export default [
+	{ files: ["source/**"], languageOptions: { sourceType: "commonjs" } },
+	{ languageOptions: { globals: { ...globals.browser, ...globals.mocha, } } },
+	pluginJs.configs.recommended,
+	{ rules: { "no-prototype-builtins": "off", "no-unused-vars": "warn", "no-case-declarations": "warn" } },
+];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pict-section-form",
-    "version": "1.0.13",
+    "version": "1.0.15",
     "description": "Pict dynamic form sections",
     "main": "source/Pict-Section-Form.js",
     "directories": {
@@ -19,20 +19,27 @@
         "tests": "npx mocha -u tdd --exit -R spec --grep",
         "coverage": "npx nyc --reporter=lcov --reporter=text-lcov npx mocha -- -u tdd -R spec",
         "build": "npx quack build",
-        "test": "npx mocha -u tdd -R spec"
+        "test": "npx mocha -u tdd -R spec",
+        "lint": "eslint source/**",
+        "types": "npx -p typescript tsc -p . --outDir types"
     },
+    "types": "types/Pict-Section-Form.d.ts",
     "author": "steven velozo <steven@velozo.com>",
     "license": "MIT",
     "devDependencies": {
+        "@eslint/js": "^9.4.0",
         "browser-env": "^3.3.0",
+        "eslint": "^9.4.0",
         "jquery": "^3.7.1",
-        "pict": "^1.0.199",
+        "pict": "^1.0.200",
         "pict-application": "^1.0.18",
-        "quackage": "^1.0.30"
+        "quackage": "^1.0.30",
+        "typescript": "^5.4.5"
     },
     "dependencies": {
         "fable-serviceproviderbase": "^3.0.13",
         "pict-provider": "^1.0.2",
+        "pict-template": "^1.0.1",
         "pict-view": "^1.0.47"
     },
     "mocha": {

package/source/application/Pict-Application-Form.js

@@ -39,4 +39,4 @@ module.exports.default_configuration = (
 		{
 			"Product": "PictDefaultFormsApp"
 		}
-});
+});

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

@@ -0,0 +1,33 @@
+const libPictProvider = require('pict-provider');
+
+const _DefaultProviderConfiguration = (
+{
+	"ProviderIdentifier": "Pict-DynamicForms-Layout",
+
+	"AutoInitialize": true,
+	"AutoInitializeOrdinal": 0,
+
+	"AutoSolveWithApp": false
+});
+
+/**
+ * The PictDynamicLayout class is a provider that generates dynamic layouts based on configuration.
+ */
+class PictDynamicLayout extends libPictProvider
+{
+	/**
+	 * Creates an instance of the PictDynamicLayout class.
+	 * 
+	 * @param {object} pFable - The fable object.
+	 * @param {object} pOptions - The options object.
+	 * @param {object} pServiceHash - The service hash object.
+	 */
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		let tmpOptions = Object.assign({}, JSON.parse(JSON.stringify(_DefaultProviderConfiguration)), pOptions);
+		super(pFable, tmpOptions, pServiceHash);
+	}
+}
+
+module.exports = PictDynamicLayout;
+module.exports.default_configuration = _DefaultProviderConfiguration;

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

@@ -2,7 +2,7 @@ const libPictProvider = require('pict-provider');
 
 const _DefaultProviderConfiguration = (
 {
-	"ProviderIdentifier": "Pict-DynamicForm-Solve",
+	"ProviderIdentifier": "Pict-DynamicForms-Solver",
 
 	"AutoInitialize": true,
 	"AutoInitializeOrdinal": 0,
@@ -10,8 +10,18 @@ const _DefaultProviderConfiguration = (
 	"AutoSolveWithApp": false
 });
 
-class PictSectionFormTemplateProvider extends libPictProvider
+/**
+ * The PictDynamicSolver class is a provider that solves configuration-generated dynamic views.
+ */
+class PictDynamicSolver extends libPictProvider
 {
+	/**
+	 * Creates an instance of the PictDynamicSolver class.
+	 * 
+	 * @param {object} pFable - The fable object.
+	 * @param {object} pOptions - The options object.
+	 * @param {object} pServiceHash - The service hash object.
+	 */
 	constructor(pFable, pOptions, pServiceHash)
 	{
 		let tmpOptions = Object.assign({}, JSON.parse(JSON.stringify(_DefaultProviderConfiguration)), pOptions);
@@ -33,7 +43,6 @@ class PictSectionFormTemplateProvider extends libPictProvider
 		let tmpSolver = pSolver;
 		if (tmpSolver === undefined)
 		{
-			console.log('wut');
 			return;
 		}
 		if (typeof(tmpSolver) === 'string')
@@ -42,7 +51,7 @@ class PictSectionFormTemplateProvider extends libPictProvider
 		}
 		if (!('Expression' in tmpSolver))
 		{
-			pView.log.error(`Dynamic View [${pView.UUID}]::[${pView.Hash}] group ${tmpGroup.Hash} solver ${k} is missing the Expression property.`);
+			this.pict.log.error(`Dynamic View solver ${pOrdinal} is missing the Expression property.`, { Solver: pSolver });
 			return;
 		}
 		if (!(`Ordinal` in tmpSolver))
@@ -60,7 +69,8 @@ class PictSectionFormTemplateProvider extends libPictProvider
 	}
 
 	/**
-	 * Runs each recordset solver formulae for a dynamic view group at a given ordinal.
+	 * Runs each RecordSet solver formulae for a dynamic view group at a given ordinal.
+	 * 
 	 * Or for all ordinals if no ordinal is passed.
 	 *
 	 * @param {array} pGroupSolverArray - An array of Solvers from the groups to solve.
@@ -82,7 +92,13 @@ class PictSectionFormTemplateProvider extends libPictProvider
 				continue;
 			}
 
-			tmpView.log.trace(`Dynamic View [${tmpView.UUID}]::[${tmpView.Hash}] solving RecordSet ordinal ${tmpSolver.Ordinal} [${tmpSolver.Expression}]`);
+			tmpSolver.StartTimeStamp = +new Date();
+			tmpSolver.Hash = `${pGroupSolverArray[j].ViewHash}-GroupSolver-${j}`;
+
+			if (this.pict.LogNoisiness > 1)
+			{
+				tmpView.log.trace(`Dynamic View [${tmpView.UUID}]::[${tmpView.Hash}] solving RecordSet ordinal ${tmpSolver.Ordinal} [${tmpSolver.Expression}]`);
+			}
 
 			let tmpRecordSet = tmpView.getTabularRecordSet(j);
 
@@ -92,26 +108,33 @@ class PictSectionFormTemplateProvider extends libPictProvider
 				for (let l = 0; l < tmpRecordSetKeys.length; l++)
 				{
 					let tmpRecord = tmpRecordSet[tmpRecordSetKeys[l]];
-					let tmpResultsObject = {};
-					let tmpSolutionValue = tmpView.fable.ExpressionParser.solve(tmpSolver.Expression, tmpRecord, tmpResultsObject, tmpGroup.supportingManifest, tmpRecord);
-					tmpView.log.trace(`Group ${tmpGroup.Hash} [${tmpSolver.Expression}] record ${l} result was ${tmpSolutionValue}`);
+					tmpSolver.ResultsObject = {};
+					let tmpSolutionValue = tmpView.fable.ExpressionParser.solve(tmpSolver.Expression, tmpRecord, tmpSolver.ResultsObject, tmpGroup.supportingManifest, tmpRecord);
+					if (this.pict.LogNoisiness > 1)
+					{
+						tmpView.log.trace(`Group ${tmpGroup.Hash} [${tmpSolver.Expression}] record ${l} result was ${tmpSolutionValue}`);
+					}
 				}
 			}
-			if (typeof(tmpRecordSet) == 'array')
+			if (Array.isArray(tmpRecordSet))
 			{
 				for (let l = 0; l < tmpRecordSet.length; l++)
 				{
 					let tmpRecord = tmpRecordSet[l];
-					let tmpResultsObject = {};
-					let tmpSolutionValue = tmpView.fable.ExpressionParser.solve(tmpSolver.Expression, tmpRecord, tmpResultsObject, tmpGroup.supportingManifest, tmpRecord);
-					tmpView.log.trace(`Group ${tmpGroup.Hash} [${tmpSolver.Expression}] record ${l} result was ${tmpSolutionValue}`);
+					tmpSolver.ResultsObject = {};
+					let tmpSolutionValue = tmpView.fable.ExpressionParser.solve(tmpSolver.Expression, tmpRecord, tmpSolver.ResultsObject, tmpGroup.supportingManifest, tmpRecord);
+					if (this.pict.LogNoisiness > 1)
+					{
+						tmpView.log.trace(`Group ${tmpGroup.Hash} [${tmpSolver.Expression}] record ${l} result was ${tmpSolutionValue}`);
+					}
 				}
 			}
+			tmpSolver.EndTimeStamp = +new Date();
 		}
 	}
 
 	/**
-	 * Executes the section solvers.
+	 * Executes the section solvers at a given ordinal (or all if no ordinal is passed).
 	 *
 	 * @param {Array} pViewSectionSolverArray - The array of view section solvers.
 	 * @param {number} pOrdinal - The ordinal value.
@@ -129,16 +152,26 @@ class PictSectionFormTemplateProvider extends libPictProvider
 				continue;
 			}
 
+			tmpSolver.StartTimeStamp = +new Date();
+			tmpSolver.Hash = `${pViewSectionSolverArray[i].ViewHash}-SectionSolver-${i}`;
+
 			// TODO: Precompile the solvers (it's super easy)
-			tmpView.log.trace(`Dynamic View [${tmpView.UUID}]::[${tmpView.Hash}] solving equation ${i} ordinal ${tmpSolver.Ordinal} [${tmpView.options.Solvers[i]}]`);
-			let tmpResultsObject = {};
-			let tmpSolutionValue = tmpView.fable.ExpressionParser.solve(tmpSolver.Expression, tmpView.getMarshalDestinationObject(), tmpResultsObject, tmpView.sectionManifest, tmpView.getMarshalDestinationObject());
-			tmpView.log.trace(`[${tmpSolver.Expression}] result was ${tmpSolutionValue}`);
+			if (this.pict.LogNoisiness > 1)
+			{
+				tmpView.log.trace(`Dynamic View [${tmpView.UUID}]::[${tmpView.Hash}] solving equation ${i} ordinal ${tmpSolver.Ordinal} [${tmpView.options.Solvers[i]}]`);
+			}
+			tmpSolver.ResultsObject = {};
+			let tmpSolutionValue = tmpView.fable.ExpressionParser.solve(tmpSolver.Expression, tmpView.getMarshalDestinationObject(), tmpSolver.ResultsObject, tmpView.sectionManifest, tmpView.getMarshalDestinationObject());
+			if (this.pict.LogNoisiness > 1)
+			{
+				tmpView.log.trace(`[${tmpSolver.Expression}] result was ${tmpSolutionValue}`);
+			}
+			tmpSolver.EndTimeStamp = +new Date();
 		}
 	}
 
 	/**
-	 * Executes the view solvers for the given array of views.
+	 * Executes the view solvers for the given array of view hashes.
 	 *
 	 * @param {Array} pViewSolverArray - The array of view solvers to execute.
 	 * @param {number} pOrdinal - The ordinal value.
@@ -154,13 +187,28 @@ class PictSectionFormTemplateProvider extends libPictProvider
 			{
 				continue;
 			}
-			// Solve a normal view
-			tmpView.log.trace(`Dynamic View [${tmpView.UUID}]::[${tmpView.Hash}] running solve() on view [${pViewSolverArray[i].ViewHash}`);
+			tmpSolver.Hash = `${pViewSolverArray[i].ViewHash}-ViewSolve-${i}`;
+			tmpSolver.StartTimeStamp = +new Date();
+			if (this.pict.LogNoisiness > 1)
+			{
+				tmpView.log.trace(`Dynamic View [${tmpView.UUID}]::[${tmpView.Hash}] running solve() on view [${pViewSolverArray[i].ViewHash}`);
+			}
+			// Solve with the normal view solve() pipeline
 			let tmpView = this.pict.views[pViewSolverArray[i].ViewHash];
 			tmpView.solve();
+			tmpSolver.EndTimeStamp = +new Date();
 		}
 	}
 
+	/**
+	 * Checks if the given ordinal exists in the provided ordinal set. 
+	 * 
+	 * If not, it adds the ordinal to the set.
+	 * 
+	 * @param {number} pOrdinal - The ordinal to check.
+	 * @param {Object} pOrdinalSet - The ordinal set to check against.
+	 * @returns {Object} - The ordinal object from the ordinal set.
+	 */
 	checkAutoSolveOrdinal (pOrdinal, pOrdinalSet)
 	{
 		if (!(pOrdinal.toString() in pOrdinalSet))
@@ -179,7 +227,7 @@ class PictSectionFormTemplateProvider extends libPictProvider
 	 * order across two dimensions:
 	 * 
 	 * 1. The order of the views in the view hash array.
-	 * 2. Precedence order
+	 * 2. Precedence order (based on Ordinal)
 	 * 
 	 * The way it manages the precedence order solving is by enumerating the 
 	 * view hash array multiple times until it exhausts the solution set.
@@ -197,8 +245,12 @@ class PictSectionFormTemplateProvider extends libPictProvider
 		this.log.trace(`Dynamic View Provider [${this.UUID}]::[${this.Hash}] solving views.`);
 		let tmpViewHashes = Array.isArray(pViewHashes) ? pViewHashes : Object.keys(this.fable.views);
 
-		let tmpOrdinalsToSolve = {};
+		let tmpSolveOutcome = {};
+		tmpSolveOutcome.StartTimeStamp = +new Date();
+		tmpSolveOutcome.ViewHashes = tmpViewHashes;
 
+		let tmpOrdinalsToSolve = {};
+		tmpSolveOutcome.SolveOrdinals = tmpOrdinalsToSolve;
 		for (let i = 0; i < tmpViewHashes.length; i++)
 		{
 			let tmpView = this.fable.views[tmpViewHashes[i]];
@@ -250,15 +302,22 @@ class PictSectionFormTemplateProvider extends libPictProvider
 		// Now enumerate the keys and solve each layer of the solution set
 		for (let i = 0; i < tmpOrdinalKeys.length; i++)
 		{
+			if (this.pict.LogNoisiness > 1)
+			{
+				this.log.trace(`DynamicSolver [${this.UUID}]::[${this.Hash}] Solving ordinal ${tmpOrdinalKeys[i]}`);
+			}
 			let tmpOrdinalContainer = tmpOrdinalsToSolve[tmpOrdinalKeys[i]];
 			this.executeGroupSolvers(tmpOrdinalContainer.GroupSolvers, tmpOrdinalKeys[i]);
 			this.executeSectionSolvers(tmpOrdinalContainer.SectionSolvers, tmpOrdinalKeys[i]);
 			this.executeViewSolvers(tmpOrdinalContainer.ViewSolvers, tmpOrdinalKeys[i]);
 		}
-		
-		console.log(tmpOrdinalsToSolve);
+
+		tmpSolveOutcome.EndTimeStamp = +new Date();
+
+		// It's up to the developer to decide if they want to use this information somewhere.
+		this.lastSolveOutcome = tmpSolveOutcome;
 	}
 }
 
-module.exports = PictSectionFormTemplateProvider;
-module.exports.default_configuration = _DefaultProviderConfiguration;
+module.exports = PictDynamicSolver;
+module.exports.default_configuration = _DefaultProviderConfiguration;

package/source/providers/Pict-Provider-DynamicTemplates-DefaultFormTemplates.js

@@ -17,7 +17,7 @@ module.exports = (
   ;,//;,    ,;/
  o:::::::;;///
 >::::::::;;\\\
-  ''\\\\\'" ';\
+  ''\\\\'" ';\
 
 Glug glug glug Oo... -->
 <div id="Pict-{~D:Context[0].UUID~}-FormContainer" class="pict-form">`
@@ -341,4 +341,4 @@ Glug glug glug Oo... -->
 		 */
 
 	]
-});
+});

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

@@ -4,7 +4,7 @@ const _DefaultFormTemplates = require('./Pict-Provider-DynamicTemplates-DefaultF
 
 const _DefaultProviderConfiguration = (
 {
-	"ProviderIdentifier": "Pict-Section-Form-Provider-Templates-Basic",
+	"ProviderIdentifier": "Pict-DynamicForms-MetaTemplates-Basic",
 
 	"AutoInitialize": true,
 	"AutoInitializeOrdinal": 0,
@@ -12,7 +12,7 @@ const _DefaultProviderConfiguration = (
 	"AutoSolveWithApp": false
 });
 
-class PictSectionFormTemplateProvider extends libPictProvider
+class PictDynamicFormsTemplates extends libPictProvider
 {
 	constructor(pFable, pOptions, pServiceHash)
 	{
@@ -29,12 +29,12 @@ class PictSectionFormTemplateProvider extends libPictProvider
 		this.formsTemplateSetPrefix = '';
 		this.formsTemplateSet = {};
 
-		if (!('TemplatePrefix' in this.options.MetaTemplateSet) && (this.options.ProviderIdentifier == 'Pict-Section-Form-Provider-Templates-Basic'))
+		if (!('TemplatePrefix' in this.options.MetaTemplateSet) && (this.options.ProviderIdentifier == 'Pict-DynamicForms-MetaTemplates-Basic'))
 		{
 			// The default template prefix is 'Pict-Forms-Basic'
 			this.formsTemplateSetPrefix = _DefaultFormTemplates.TemplatePrefix;
 		}
-		else if (!('TemplatePrefix' in this.options.MetaTemplateSet) && (this.options.ProviderIdentifier != 'Pict-Section-Form-Provider-Templates-Basic'))
+		else if (!('TemplatePrefix' in this.options.MetaTemplateSet) && (this.options.ProviderIdentifier != 'Pict-DynamicForms-MetaTemplates-Basic'))
 		{
 			this.log.error(`No TemplatePrefix defined in the provider options.MetaTemplateSet.TemplatePrefix -- Provider [${this.UUID}]::[${this.Hash}].  Templates will not be loaded.`);
 		}
@@ -86,5 +86,5 @@ class PictSectionFormTemplateProvider extends libPictProvider
 	}
 }
 
-module.exports = PictSectionFormTemplateProvider;
+module.exports = PictDynamicFormsTemplates;
 module.exports.default_configuration = _DefaultProviderConfiguration;

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

@@ -3,7 +3,7 @@ const libPictProvider = require('pict-provider');
 // TODO: Pull this back to pict as a core service once we are happy with the shape.
 const _DefaultProviderConfiguration = (
 {
-	"ProviderIdentifier": "Pict-Section-Form-Provider-Informary",
+	"ProviderIdentifier": "Pict-DynamicForms-Informary",
 
 	"AutoInitialize": false,
 	"AutoInitializeOrdinal": 0,
@@ -11,8 +11,18 @@ const _DefaultProviderConfiguration = (
 	"AutoSolveWithApp": false
 });
 
-class PictServiceInformary extends libPictProvider
+/**
+ * Represents a provider for dynamic forms in the PICT system.
+ * Extends the `libPictProvider` class.
+ */
+class PictDynamicFormsInformary extends libPictProvider
 {
+	/**
+	 * Creates an instance of the `PictDynamicFormsInformary` class.
+	 * @param {object} pFable - The fable object.
+	 * @param {object} pOptions - The options object.
+	 * @param {object} pServiceHash - The service hash object.
+	 */
 	constructor(pFable, pOptions, pServiceHash)
 	{
 		let tmpOptions = Object.assign({}, JSON.parse(JSON.stringify(_DefaultProviderConfiguration)), pOptions);
@@ -22,6 +32,12 @@ class PictServiceInformary extends libPictProvider
 		this.genericManifest = this.pict.newManyfest({Scope:'GenericInformary'});		
 	}
 
+	/**
+	 * Retrieves all form elements for a given form hash.
+	 *
+	 * @param {string} pFormHash - The hash of the form.
+	 * @returns {HTMLElement[]} - An array of HTML elements representing the form elements.
+	 */
 	getFormElements(pFormHash)
 	{
 		let tmpSelector = `[data-i-form="${pFormHash}"]`;
@@ -29,6 +45,17 @@ class PictServiceInformary extends libPictProvider
 		return this.pict.ContentAssignment.getElement(tmpSelector);
 	}
 
+	/**
+	 * Get a full content browser address based on the form, datum and optionally the container and index.
+	 * 
+	 * This can be used in getDomElementByAddress or jquery selectors to return the element.
+	 *
+	 * @param {string} pFormHash - The form hash.
+	 * @param {string} pDatumHash - The datum hash.
+	 * @param {string|null} pContainer - The container (optional).
+	 * @param {number} pIndex - The index.
+	 * @returns {string} The content browser address.
+	 */
 	getContentBrowserAddress(pFormHash, pDatumHash, pContainer, pIndex)
 	{
 		// TODO: Need some guards, yo
@@ -42,12 +69,26 @@ class PictServiceInformary extends libPictProvider
 		}
 	}
 
+	/**
+	 * Returns the composed container address string for a given container, index, and datum hash.
+	 *
+	 * @param {string} pContainer - The container name.
+	 * @param {number} pIndex - The index of the container.
+	 * @param {string} pDatumHash - The datum hash.
+	 * @returns {string} The composed container address.
+	 */
 	getComposedContainerAddress(pContainer, pIndex, pDatumHash)
 	{
 		return `${pContainer}[${pIndex}].${pDatumHash}`;
 	}
 
-	// TODO: DRY or bust.  Later.
+	/**
+	 * Marshals form data to the provided application state data object using the given form hash and manifest.
+	 *
+	 * @param {object} pAppStateData - The application state data object to marshal the form data to.
+	 * @param {string} pFormHash - The form hash representing the form elements.
+	 * @param {object} pManifest - The manifest object used to map form data to the application state data.
+	 */
 	marshalFormToData(pAppStateData, pFormHash, pManifest)
 	{
 		let tmpManifest = typeof(pManifest) === 'object' ? pManifest : this.genericManifest;
@@ -85,6 +126,13 @@ class PictServiceInformary extends libPictProvider
 		}
 	}
 
+	/**
+	 * Marshals data from some application state object to a specific subset of browser form elements.
+	 *
+	 * @param {object} pAppStateData - The application state data to marshal into the form.  Usually AppData but can be other objects.
+	 * @param {string} pFormHash - The hash of the form to marshal data into.  This is the data-i-form attribute.
+	 * @param {object} pManifest - The manifest object.  If not provided, the generic manifest is used.
+	 */
 	marshalDataToForm(pAppStateData, pFormHash, pManifest)
 	{
 		let tmpManifest = typeof(pManifest) === 'object' ? pManifest : this.genericManifest;
@@ -130,5 +178,5 @@ class PictServiceInformary extends libPictProvider
 	}
 }
 
-module.exports = PictServiceInformary;
+module.exports = PictDynamicFormsInformary;
 module.exports.default_configuration = _DefaultProviderConfiguration;

package/source/templates/Pict-Template-Metacontroller-ValueSetWithGroup.js

@@ -1,5 +1,10 @@
-const libPictTemplate = require('./Pict-Template-Base.js');
+const libPictTemplate = require('pict-template');
 
+/**
+ * This is a template that will take a value set and render a template for each value in the set.
+ * 
+ * It passes along additional context (the metacontroller group) for dynamic programming tables.
+ */
 class PictTemplateMetacontrollerValueSet extends libPictTemplate
 {
 	/**
@@ -123,7 +128,7 @@ class PictTemplateMetacontrollerValueSet extends libPictTemplate
 		{
 			for (let i = 0; i < tmpData.length; i++)
 			{
-				tmpDataValueSet.push({ Value: tmpData[i], Key: i, Group: tmpGroupIndex });
+				tmpDataValueSet.push({ Value: tmpData[i], Key: i, });
 			}
 		}
 		else if (typeof (tmpData) === 'object')
@@ -131,7 +136,7 @@ class PictTemplateMetacontrollerValueSet extends libPictTemplate
 			let tmpValueKeys = Object.keys(tmpData);
 			for (let i = 0; i < tmpValueKeys.length; i++)
 			{
-				tmpDataValueSet.push({ Value: tmpData[tmpValueKeys[i]], Key: tmpValueKeys[i], Group: tmpGroupIndex  });
+				tmpDataValueSet.push({ Value: tmpData[tmpValueKeys[i]], Key: tmpValueKeys[i] });
 			}
 		}
 		else

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

@@ -13,12 +13,10 @@ class PictViewDynamicForm extends libPictViewClass
 		if (!tmpOptions.Manifests)
 		{
 			throw new Error('PictSectionForm instantiation attempt without a Manifests in pOptions.Manifest -- cannot instantiate.');
-			return;
 		}
 		if (!('Section' in tmpOptions.Manifests))
 		{
 			throw new Error('PictSectionForm instantiation attempt without a Section manifest in pOptions.Manifests -- cannot instantiate.');
-			return;
 		}
 
 		// Set the default destination address to be based on the section hash if it hasn't been overridden by the manifest section definition
@@ -85,12 +83,6 @@ class PictViewDynamicForm extends libPictViewClass
 			let tmpDynamicSolver = this.pict.addProvider('DynamicSolver', libDynamicSolver.default_configuration, libDynamicSolver);
 			tmpDynamicSolver.initialize();
 		}
-		// This is for if we decide to abstract metatemplates into a separate provider for code simplification
-		// if (!this.pict.providers.PictFormSectionMetatemplateGenerator)
-		// {
-		// 	let tmpMetatemplateGenerator = this.pict.addProvider('PictFormSectionMetatemplateGenerator', libFormsMetatemplateGenerator.default_configuration, libFormsMetatemplateGenerator);
-		// 	tmpMetatemplateGenerator.initialize();
-		// }
 
 		// Load any view section-specific templates
 		this.formsTemplateSetPrefix = `PFT-${this.Hash}-${this.UUID}`;
@@ -127,16 +119,6 @@ class PictViewDynamicForm extends libPictViewClass
 		this.initializeFormGroups();
 	}
 
-	addSolver(pSolveFunctionString)
-	{
-		return (
-			{
-				"Type": "SingleSolve",
-				"Priority": 0,
-				"SolveFunction": pSolveFunctionString
-			});
-	}
-
 	renderToPrimary()
 	{
 		// Render to the primary view that the 
@@ -981,4 +963,4 @@ class PictViewDynamicForm extends libPictViewClass
 	}
 }
 
-module.exports = PictViewDynamicForm;
+module.exports = PictViewDynamicForm;

package/source/views/Pict-View-Form-Metacontroller.js

@@ -86,6 +86,16 @@ class PictFormMetacontroller extends libPictViewClass
 		return super.onSolve();
 	}
 
+
+	/**
+	 * Filters the views based on the provided filter and sort functions.
+	 * 
+	 * By default, filters views based on the provided filter function and sorts them based on the provided sort function.
+	 * 
+	 * @param {Function} fFilterFunction - The filter function used to determine if a view should be included.
+	 * @param {Function} fSortFunction - The sort function used to sort the filtered views.
+	 * @returns {Array} - The filtered and sorted views.
+	 */
 	filterViews(fFilterFunction, fSortFunction)
 	{
 		let tmpViewList = Object.keys(this.fable.views);
@@ -113,6 +123,14 @@ class PictFormMetacontroller extends libPictViewClass
 		return tmpFilteredViewList;
 	}
 
+	/**
+	 * Renders a specific dynamic form section based on the provided form section hash.
+	 * 
+	 * For this to work, we need the container for the section to be available on the form.
+	 *
+	 * @param {string} pFormSectionHash - The hash of the form section to render.
+	 * @returns {void}
+	 */
 	renderSpecificFormSection(pFormSectionHash)
 	{
 		let fViewFilter = (pView) => { return pView.Hash == pFormSectionHash; };
@@ -120,6 +138,14 @@ class PictFormMetacontroller extends libPictViewClass
 		this.render();
 	}
 
+	/**
+	 * Renders the form sections based on the provided filter and sort functions.
+	 * 
+	 * If no filter and sort functions are provided, render all form sections.
+	 *
+	 * @param {Function} fFilterFunction - The filter function used to filter the views.
+	 * @param {Function} fSortFunction - The sort function used to sort the views.
+	 */
 	renderFormSections(fFilterFunction, fSortFunction)
 	{
 		let tmpViewList = this.filterViews(fFilterFunction, fSortFunction);
@@ -223,7 +249,7 @@ class PictFormMetacontroller extends libPictViewClass
 		}
 		catch(pError)
 		{
-			this.log.error('getSectionDefinition() failed to parse the section object.');
+			this.log.error(`getSectionDefinition() failed to parse the section object with error: ${pError.message || pError}`);
 			return false;
 		}
 	}