pict-section-form 1.0.32 → 1.0.33

package/debug/PICTSection-TabularManifests.json

@@ -59,8 +59,6 @@
                     "InputType": "Option",
                     "Row": "3",
                     "Width": "1",
-                    "Units": "planetary",
-                    "New": "Y",
                     "SelectOptions": [
                         {
                             "id": "Earth",
@@ -80,7 +78,9 @@
                         }
                     ],
                     "Section": "Header",
-                    "Group": "General_Info"
+                    "Group": "General_Info",
+                    "Units": "planetary",
+                    "New": "Y"
                 }
             },
             "Header.Location.Address": {
@@ -91,9 +91,9 @@
                 "PictForm": {
                     "Row": "1",
                     "Width": "1",
-                    "ExternalDatabaseID": "A-001",
                     "Section": "Header",
-                    "Group": "Address"
+                    "Group": "Address",
+                    "ExternalDatabaseID": "A-001"
                 }
             },
             "Header.Location.City": {
@@ -128,9 +128,9 @@
                 "PictForm": {
                     "Row": "2",
                     "Width": "1",
-                    "ExternalDatabaseID": "A-003",
                     "Section": "Header",
-                    "Group": "Address"
+                    "Group": "Address",
+                    "ExternalDatabaseID": "A-003"
                 }
             },
             "Header.Location.Country": {
@@ -161,15 +161,7 @@
                 "Hash": "PackageAddress",
                 "Name": "PackageAddress",
                 "DataAddress": "Inventory.Packages",
-                "DataType": "Array",
-                "PictForm": {
-                    "InputType": "TabularAddress",
-                    "Row": "1",
-                    "Width": "3",
-                    "ExternalDatabaseID": "X-11",
-                    "Section": "Package_Dimensions",
-                    "Group": "Size"
-                }
+                "DataType": "Array"
             },
             "Packages[].Area": {
                 "Hash": "AreaSet",
@@ -287,9 +279,9 @@
                         "PictForm": {
                             "Row": "2",
                             "Width": "1",
-                            "Units": "inches",
                             "Section": "Package_Dimensions",
-                            "Group": "Size"
+                            "Group": "Size",
+                            "Units": "inches"
                         },
                         "IsTabular": true
                     },
@@ -301,9 +293,9 @@
                         "PictForm": {
                             "Row": "2",
                             "Width": "1",
-                            "Units": "inches",
                             "Section": "Package_Dimensions",
-                            "Group": "Size"
+                            "Group": "Size",
+                            "Units": "inches"
                         },
                         "IsTabular": true
                     },
@@ -315,9 +307,9 @@
                         "PictForm": {
                             "Row": "3",
                             "Width": "2",
-                            "Units": "square inches",
                             "Section": "Package_Dimensions",
-                            "Group": "Size"
+                            "Group": "Size",
+                            "Units": "square inches"
                         },
                         "IsTabular": true
                     }

package/debug/ParseCSV-CustomManifestCSVFactory.js

@@ -0,0 +1,27 @@
+const libManifestFactory = require('../source/services/ManifestFactory.js');
+
+class CustomManifestCSVFactory extends libManifestFactory
+{
+	constructor(pFable, pSettings, pServiceHash)
+	{
+		super(pFable, pSettings, pServiceHash);
+	}
+
+	onTabularRowAddDescriptor(pIncomingDescriptor, pSection, pGroup, pNewDescriptor)
+	{
+		if (pIncomingDescriptor.Units)
+		{
+			pNewDescriptor.PictForm.Units = pIncomingDescriptor.Units;
+		}
+		if (pIncomingDescriptor['External Database ID'])
+		{
+			pNewDescriptor.PictForm.ExternalDatabaseID = pIncomingDescriptor['External Database ID'];
+		}
+		if (pIncomingDescriptor['New'])
+		{
+			pNewDescriptor.PictForm.New = pIncomingDescriptor['New'];
+		}
+	}
+}
+
+module.exports = CustomManifestCSVFactory;

package/debug/ParseCSV.js

@@ -43,7 +43,8 @@ class ImportCSVCommand extends libPictCommandLineUtility.ServiceCommandLineComma
 		}
 	
 		// The ManifestFactory gives us a programmatic way to manage Manifest config consistently
-		this.fable.addAndInstantiateServiceType('ManifestFactory', require('../source/services/ManifestFactory.js'));
+		this.fable.addAndInstantiateServiceType('ManifestFactory', require('./ParseCSV-CustomManifestCSVFactory.js'));
+		//this.fable.addAndInstantiateServiceType('ManifestFactory', require('../source/services/ManifestFactory.js'));
 		// Initialize the CSV parser
 		this.fable.instantiateServiceProvider('CSVParser');
 		this.fable.instantiateServiceProvider('FilePersistence');

package/debug/data/ExampleForm.json

@@ -58,8 +58,6 @@
                 "InputType": "Option",
                 "Row": "3",
                 "Width": "1",
-                "Units": "planetary",
-                "New": "Y",
                 "SelectOptions": [
                     {
                         "id": "Earth",
@@ -79,7 +77,9 @@
                     }
                 ],
                 "Section": "Header",
-                "Group": "General_Info"
+                "Group": "General_Info",
+                "Units": "planetary",
+                "New": "Y"
             }
         },
         "Header.Location.Address": {
@@ -90,9 +90,9 @@
             "PictForm": {
                 "Row": "1",
                 "Width": "1",
-                "ExternalDatabaseID": "A-001",
                 "Section": "Header",
-                "Group": "Address"
+                "Group": "Address",
+                "ExternalDatabaseID": "A-001"
             }
         },
         "Header.Location.City": {
@@ -127,9 +127,9 @@
             "PictForm": {
                 "Row": "2",
                 "Width": "1",
-                "ExternalDatabaseID": "A-003",
                 "Section": "Header",
-                "Group": "Address"
+                "Group": "Address",
+                "ExternalDatabaseID": "A-003"
             }
         },
         "Header.Location.Country": {
@@ -160,15 +160,7 @@
             "Hash": "PackageAddress",
             "Name": "PackageAddress",
             "DataAddress": "Inventory.Packages",
-            "DataType": "Array",
-            "PictForm": {
-                "InputType": "TabularAddress",
-                "Row": "1",
-                "Width": "3",
-                "ExternalDatabaseID": "X-11",
-                "Section": "Package_Dimensions",
-                "Group": "Size"
-            }
+            "DataType": "Array"
         },
         "Packages[].Area": {
             "Hash": "AreaSet",
@@ -286,9 +278,9 @@
                     "PictForm": {
                         "Row": "2",
                         "Width": "1",
-                        "Units": "inches",
                         "Section": "Package_Dimensions",
-                        "Group": "Size"
+                        "Group": "Size",
+                        "Units": "inches"
                     },
                     "IsTabular": true
                 },
@@ -300,9 +292,9 @@
                     "PictForm": {
                         "Row": "2",
                         "Width": "1",
-                        "Units": "inches",
                         "Section": "Package_Dimensions",
-                        "Group": "Size"
+                        "Group": "Size",
+                        "Units": "inches"
                     },
                     "IsTabular": true
                 },
@@ -314,9 +306,9 @@
                     "PictForm": {
                         "Row": "3",
                         "Width": "2",
-                        "Units": "square inches",
                         "Section": "Package_Dimensions",
-                        "Group": "Size"
+                        "Group": "Size",
+                        "Units": "square inches"
                     },
                     "IsTabular": true
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pict-section-form",
-    "version": "1.0.32",
+    "version": "1.0.33",
     "description": "Pict dynamic form sections",
     "main": "source/Pict-Section-Form.js",
     "directories": {

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

@@ -1,8 +1,15 @@
 const libPictApplication = require('pict-application');
-//const libPictApplication = require('../../../pict-application/source/Pict-Application.js');
 
 const libPictSectionForm = require('../Pict-Section-Form.js');
 
+/**
+ * Represents a PictSectionFormApplication.
+ * 
+ * This is the automagic controller for a dyncamic form application.
+ * 
+ * @class
+ * @extends libPictApplication
+ */
 class PictSectionFormApplication extends libPictApplication
 {
 	constructor(pFable, pOptions, pServiceHash)
@@ -16,11 +23,17 @@ class PictSectionFormApplication extends libPictApplication
 		this.pict.addView('PictFormMetacontroller', {}, libPictSectionForm.PictFormMetacontroller);
 	}
 
+	/**
+	 * Marshals data from any rendered dynamic views to application data.
+	 */
 	marshalDataFromDynamicViewsToAppData()
 	{
 		this.pict.views.PictFormMetacontroller.marshalFromView();
 	}
 
+	/**
+	 * Marshals data from the application data to any rendered dynamic views.
+	 */
 	marshalDataFromAppDataToDynamicViews()
 	{
 		this.pict.views.PictFormMetacontroller.marshalToView();

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

@@ -30,6 +30,13 @@ class PictDynamicInput extends libPictProvider
 		this.templateProviderMap = {};
 	}
 
+	/**
+	 * Retrieves the template hash for the input based on the provided view and input.
+	 *
+	 * @param {View} pView - The view object.
+	 * @param {Input} pInput - The input object.
+	 * @returns {string|boolean} - The template hash if found, otherwise false.
+	 */
 	getInputTemplateHash(pView, pInput)
 	{
 		if (pInput.IsTabular)
@@ -80,6 +87,12 @@ class PictDynamicInput extends libPictProvider
 		return false;
 	}
 
+	/**
+	 * Adds a default input provider for a given template full hash.
+	 * 
+	 * @param {string} pTemplateFullHash - The full hash of the template.
+	 * @param {any} pProvider - The provider to be added.
+	 */
 	addDefaultInputProvider(pTemplateFullHash, pProvider)
 	{
 		if (!(pTemplateFullHash in this.templateProviderMap))
@@ -92,6 +105,13 @@ class PictDynamicInput extends libPictProvider
 		}
 	}
 
+	/**
+	 * Retrieves the default input providers based on the given view and input.
+	 *
+	 * @param {string} pView - The view to retrieve input providers for.
+	 * @param {string} pInput - The input to retrieve input providers for.
+	 * @returns {Array} An array of default input providers.
+	 */
 	getDefaultInputProviders(pView, pInput)
 	{
 		let tmpTemplateHash = this.getInputTemplateHash(pView, pInput);

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

@@ -28,6 +28,12 @@ class PictDynamicInputEvents extends libPictProvider
 		super(pFable, tmpOptions, pServiceHash);
 	}
 
+	/**
+	 * Requests input data from the view based on the provided input hash.
+	 * 
+	 * @param {Object} pView - The view object.
+	 * @param {string} pInputHash - The input hash.
+	 */
 	inputDataRequest(pView, pInputHash)
 	{
 		let tmpInput = pView.getInputFromHash(pInputHash);
@@ -62,6 +68,13 @@ class PictDynamicInputEvents extends libPictProvider
 		}
 	}
 
+	/**
+	 * Handles the input event for a dynamic form.
+	 *
+	 * @param {Object} pView - The view object.
+	 * @param {string} pInputHash - The input hash.
+	 * @param {string} pEvent - The input event.
+	 */
 	inputEvent(pView, pInputHash, pEvent)
 	{
 		let tmpInput = pView.getInputFromHash(pInputHash);
@@ -96,6 +109,14 @@ class PictDynamicInputEvents extends libPictProvider
 		}
 	}
 
+	/**
+	 * Requests input data for a tabular record.
+	 *
+	 * @param {Object} pView - The view object.
+	 * @param {number} pGroupIndex - The index of the group.
+	 * @param {number} pInputIndex - The index of the input.
+	 * @param {number} pRowIndex - The index of the row.
+	 */
 	inputDataRequestTabular(pView, pGroupIndex, pInputIndex, pRowIndex)
 	{
 		let tmpInput = pView.getTabularRecordInput(pGroupIndex, pInputIndex);
@@ -137,6 +158,15 @@ class PictDynamicInputEvents extends libPictProvider
 		pView.marshalToView();
 	}
 
+	/**
+	 * Handles the tabular input event.
+	 *
+	 * @param {Object} pView - The view object.
+	 * @param {number} pGroupIndex - The index of the group.
+	 * @param {number} pInputIndex - The index of the input.
+	 * @param {number} pRowIndex - The index of the row.
+	 * @param {string} pEvent - The input event.
+	 */
 	inputEventTabular(pView, pGroupIndex, pInputIndex, pRowIndex, pEvent)
 	{
 		let tmpInput = pView.getTabularRecordInput(pGroupIndex, pInputIndex);

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

@@ -53,6 +53,13 @@ class PictDynamicLayout extends libPictProvider
 		return true;
 	}
 
+	/**
+	 * This fires after data has been marshaled to the form from the model.
+	 * 
+	 * @param {object} pView  - The view to initialize the newly rendered control for
+	 * @param {object} pGroup - The group to initialize the newly rendered control for
+	 * @returns {boolean}
+	 */
 	onDataMarshalToForm(pView, pGroup)
 	{
 		return true;

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

@@ -33,26 +33,61 @@ class PictRecordSet extends libPictProvider
 		this.recordProviders = {};
 	}
 
+	/**
+	 * Returns the count for a specific dynamic record set.
+	 * 
+	 * @param {Object} pFilter - The filter object.
+	 * @param {Function} fCallback - The callback function to be called after the count is returned.
+	 * @returns {any} - The result of the callback function.
+	 */
 	count(pFilter, fCallback)
 	{
 		return fCallback();
 	}
 
+	/**
+	 * Reads a record list.
+	 * 
+	 * @param {Object} pFilter - The filter object.
+	 * @param {Function} fCallback - The callback function to be called after the record list is read.
+	 * @returns {any} - The result of the callback function.
+	 */
 	readRecordList(pFilter, fCallback)
 	{
 		return fCallback();
 	}
 
+	/**
+	 * Reads a record.
+	 * 
+	 * @param {Object} pFilter - The filter object.
+	 * @param {Function} fCallback - The callback function to be called after the record is read.
+	 * @returns {any} - The result of the callback function.
+	 */
 	readRecord(pFilter, fCallback)
 	{
 		return fCallback();
 	}
 
+	/**
+	 * Writes a record.
+	 * 
+	 * @param {Object} pRecord - The record to be written.
+	 * @param {Function} fCallback - The callback function to be called after the record is written.
+	 * @returns {any} - The result of the callback function.
+	 */
 	writeRecord(pRecord, fCallback)
 	{
 		return fCallback();
 	}
 
+	/**
+	 * Deletes a record.
+	 *
+	 * @param {Object} pRecord - The record to be deleted.
+	 * @param {Function} fCallback - The callback function to be called after the record is deleted.
+	 * @returns {any} - The result of the callback function.
+	 */
 	deleteRecord(pRecord, fCallback)
 	{
 		return fCallback();

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

@@ -28,6 +28,13 @@ class DynamicTabularData extends libPictProvider
 		super(pFable, tmpOptions, pServiceHash);
 	}
 
+	/**
+	 * Retrieves the tabular record set from the specified view and group index.
+	 *
+	 * @param {Object} pView - The view object.
+	 * @param {number} pGroupIndex - The index of the group.
+	 * @returns {Array|Object|boolean} - The tabular record set if it exists, otherwise false.
+	 */
 	getTabularRecordSet(pView, pGroupIndex)
 	{
 		// 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.
@@ -40,6 +47,14 @@ class DynamicTabularData extends libPictProvider
 		return pView.sectionManifest.getValueByHash(pView.getMarshalDestinationObject(), tmpGroup.RecordSetAddress);
 	}
 
+	/**
+	 * Retrieves the tabular record input from the specified view, group, and input indexes.
+	 *
+	 * @param {Object} pView - The view object.
+	 * @param {number} pGroupIndex - The index of the group.
+	 * @param {number} pInputIndex - The index of the input.
+	 * @returns {ElementDescriptor|boolean} The tabular record input or false if the group is invalid.
+	 */
 	getTabularRecordInput(pView, pGroupIndex, pInputIndex)
 	{
 		// 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.
@@ -57,6 +72,14 @@ class DynamicTabularData extends libPictProvider
 		return tmpGroup.supportingManifest.elementDescriptors[tmpSupportingManifestHash];
 	}
 
+	/**
+	 * Retrieves tabular record data based on the provided parameters.
+	 *
+	 * @param {Object} pView - The view object.
+	 * @param {number} pGroupIndex - The index of the group.
+	 * @param {string} pRowIdentifier - The identifier of the row.
+	 * @returns {boolean|Object} - The tabular record data or false if not found.
+	 */
 	getTabularRecordData(pView, pGroupIndex, pRowIdentifier)
 	{
 		// 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.
@@ -107,6 +130,12 @@ class DynamicTabularData extends libPictProvider
 		}
 	}
 
+	/**
+	 * Creates a dynamic table row for the given view and group index.
+	 * 
+	 * @param {Object} pView - The view object.
+	 * @param {number} pGroupIndex - The index of the group.
+	 */
 	createDynamicTableRow(pView, pGroupIndex)
 	{
 		let tmpGroup = pView.getGroup(pGroupIndex);
@@ -131,6 +160,15 @@ class DynamicTabularData extends libPictProvider
 		}
 	}
 
+	/**
+	 * Sets the index of a dynamic table row in a view.
+	 *
+	 * @param {Object} pView - The view object.
+	 * @param {number} pGroupIndex - The index of the group.
+	 * @param {number} pRowIndex - The current index of the row.
+	 * @param {number} pNewRowIndex - The new index to move the row to.
+	 * @returns {boolean} - Returns false if the index is out of bounds, otherwise returns undefined.
+	 */
 	setDynamicTableRowIndex(pView, pGroupIndex, pRowIndex, pNewRowIndex)
 	{
 		let tmpGroup = pView.getGroup(pGroupIndex);
@@ -160,6 +198,14 @@ class DynamicTabularData extends libPictProvider
 		}
 	}
 
+	/**
+	 * Moves a dynamic table row down within a view.
+	 *
+	 * @param {Object} pView - The view containing the dynamic table.
+	 * @param {number} pGroupIndex - The index of the group containing the row.
+	 * @param {number} pRowIndex - The index of the row to be moved.
+	 * @returns {boolean} - Returns true if the row was successfully moved, false otherwise.
+	 */
 	moveDynamicTableRowDown(pView, pGroupIndex, pRowIndex)
 	{
 		let tmpGroup = pView.getGroup(pGroupIndex);
@@ -188,6 +234,14 @@ class DynamicTabularData extends libPictProvider
 		}
 	}
 
+	/**
+	 * Moves a dynamic table row up.
+	 *
+	 * @param {Object} pView - The view object.
+	 * @param {number} pGroupIndex - The index of the group.
+	 * @param {number} pRowIndex - The index of the row to be moved.
+	 * @returns {boolean} Returns true if the row was moved successfully, false otherwise.
+	 */
 	moveDynamicTableRowUp(pView, pGroupIndex, pRowIndex)
 	{
 		let tmpGroup = pView.getGroup(pGroupIndex);
@@ -222,6 +276,14 @@ class DynamicTabularData extends libPictProvider
 	}
 
 
+	/**
+	 * Deletes a dynamic table row from the specified view.
+	 *
+	 * @param {Object} pView - The view from which to delete the row.
+	 * @param {number} pGroupIndex - The index of the group containing the row.
+	 * @param {number|string} pRowIndex - The index or key of the row to delete.
+	 * @returns {boolean} - Returns true if the row was successfully deleted, false otherwise.
+	 */
 	deleteDynamicTableRow(pView, pGroupIndex, pRowIndex)
 	{
 		let tmpGroup = pView.getGroup(pGroupIndex);

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

@@ -31,6 +31,13 @@ class PictMetalist extends libPictProvider
 		this.globalLists = {};
 	}
 
+	/**
+	 * Retrieves a list based on the provided view hash and list hash.
+	 * 
+	 * @param {string} pViewHash - The view hash.
+	 * @param {string} pListHash - The list hash.
+	 * @returns {Array} - The retrieved list.
+	 */
 	getList(pViewHash, pListHash)
 	{
 		if ((pViewHash in this.computedLists) && (pListHash in this.computedLists[pViewHash]))
@@ -44,11 +51,23 @@ class PictMetalist extends libPictProvider
 		return [];
 	}
 
+	/**
+	 * Checks if a list exists in the Pict Provider MetaLists.
+	 * 
+	 * @param {string} pViewHash - The hash of the view.
+	 * @param {string} pListHash - The hash of the list.
+	 * @returns {boolean} - Returns true if the list exists, otherwise false.
+	 */
 	hasList(pViewHash, pListHash)
 	{
 		return ((pViewHash in this.computedLists) && (pListHash in this.computedLists[pViewHash])) || (pListHash in this.globalLists);
 	}
 
+	/**
+	 * Builds meta lists for the Pict provider.
+	 * 
+	 * @param {Array|string} pViewHashes - The view hashes to build meta lists for.
+	 */
 	buildLists(pViewHashes)
 	{
 		// this.log.trace(`Dynamic MetaList Provider [${this.UUID}]::[${this.Hash}] pulling Metalists.`);