pict-section-recordset 1.0.42 → 1.0.44

package/source/providers/RecordSet-RecordProvider-MeadowEndpoints.js

@@ -365,19 +365,26 @@ class MeadowEndpointsRecordSetProvider extends libRecordSetProviderBase
 	/**
 	 * @param {string} pSchemaField - The schema field name.
 	 * @param {Record<string, any>} pColumn - The full column definition from the schema.
+	 * @param {Record<string, any>} [pMeadowSchemaField] - The meadow schema field definition.
 	 */
-	getFieldFilterClauses(pSchemaField, pColumn)
+	getFieldFilterClauses(pSchemaField, pColumn, pMeadowSchemaField)
 	{
 		/** @type {Record<string, any>} */
 		let tmpRangeClause;
 		let tmpFieldFilterClauses = this.options.FieldFilterClauses?.[pSchemaField];
 		if (!Array.isArray(tmpFieldFilterClauses))
 		{
+			let tmpFieldType = pColumn.type;
+			if (pMeadowSchemaField && typeof pMeadowSchemaField.Type === 'string')
+			{
+				tmpFieldType = pMeadowSchemaField.Type.toLowerCase();
+			}
 			tmpFieldFilterClauses = [];
 			const tmpFieldHumanName = this._getHumanReadableFieldName(pSchemaField);
-			switch (pColumn.type)
+			switch (tmpFieldType)
 			{
 				case 'string':
+				case 'autoguid':
 					tmpFieldFilterClauses.push({ FilterKey: pSchemaField, ClauseKey: `${pSchemaField}_Match_Exact`, DisplayName: `${tmpFieldHumanName} Exact Match`, Type: 'StringMatch', FilterByColumn: pSchemaField, ExactMatch: true, Ordinal: tmpFieldFilterClauses.length + 1 });
 					tmpFieldFilterClauses.push({ FilterKey: pSchemaField, ClauseKey: `${pSchemaField}_Match_Fuzzy`, DisplayName: `${tmpFieldHumanName} Partial Match`, Type: 'StringMatch', FilterByColumn: pSchemaField, ExactMatch: false , Ordinal: tmpFieldFilterClauses.length + 1 });
 					tmpRangeClause = { FilterKey: pSchemaField, ClauseKey: `${pSchemaField}_Range`, DisplayName: `${tmpFieldHumanName} in Range`, Type: 'StringRange', FilterByColumn: pSchemaField , Ordinal: tmpFieldFilterClauses.length + 1 };
@@ -387,6 +394,8 @@ class MeadowEndpointsRecordSetProvider extends libRecordSetProviderBase
 					break;
 				case 'date':
 				case 'datetime':
+				case 'createdate':
+				case 'updatedate':
 					tmpFieldFilterClauses.push({ FilterKey: pSchemaField, ClauseKey: `${pSchemaField}_Match_Exact`, DisplayName: `${tmpFieldHumanName} Exact Match`, Type: 'DateMatch', FilterByColumn: pSchemaField, ExactMatch: true , Ordinal: tmpFieldFilterClauses.length + 1 });
 					tmpFieldFilterClauses.push({ FilterKey: pSchemaField, ClauseKey: `${pSchemaField}_Match_Fuzzy`, DisplayName: `${tmpFieldHumanName} Partial Match`, Type: 'DateMatch', FilterByColumn: pSchemaField, ExactMatch: false , Ordinal: tmpFieldFilterClauses.length + 1 });
 					tmpRangeClause = { FilterKey: pSchemaField, ClauseKey: `${pSchemaField}_Range`, DisplayName: `${tmpFieldHumanName} in Range`, Type: 'DateRange', FilterByColumn: pSchemaField , Ordinal: tmpFieldFilterClauses.length + 1 };
@@ -395,7 +404,13 @@ class MeadowEndpointsRecordSetProvider extends libRecordSetProviderBase
 					tmpFieldFilterClauses.push(tmpRangeClause);
 					break;
 				case 'boolean': //TODO: we didn't add filters for this - they are just numeric but it's weird for the user, maybe we should add views for this that account for the difference
+				case 'deleted':
 				case 'integer':
+				case 'decimal':
+				case 'autoidentity':
+				case 'createiduser':
+				case 'updateiduser':
+				case 'deleteiduser':
 					tmpFieldFilterClauses.push({ FilterKey: pSchemaField, ClauseKey: `${pSchemaField}_Match_Exact`, DisplayName: `${tmpFieldHumanName} Exact Match`, Type: 'NumericMatch', FilterByColumn: pSchemaField, ExactMatch: true , Ordinal: tmpFieldFilterClauses.length + 1 });
 					tmpFieldFilterClauses.push({ FilterKey: pSchemaField, ClauseKey: `${pSchemaField}_Match_Fuzzy`, DisplayName: `${tmpFieldHumanName} Partial Match`, Type: 'NumericMatch', FilterByColumn: pSchemaField, ExactMatch: false , Ordinal: tmpFieldFilterClauses.length + 1 });
 					tmpRangeClause = { FilterKey: pSchemaField, ClauseKey: `${pSchemaField}_Range`, DisplayName: `${tmpFieldHumanName} in Range`, Type: 'NumericRange', FilterByColumn: pSchemaField , Ordinal: tmpFieldFilterClauses.length + 1 };
@@ -417,6 +432,8 @@ class MeadowEndpointsRecordSetProvider extends libRecordSetProviderBase
 	{
 		super.onInitializeAsync((pError) =>
 		{
+			//FIXME: load the most recent experience from local storage using the other provider
+			//       how do we control the initialization order of the providers?
 			if (this.options.FilterExperiences && typeof this.options.FilterExperiences === 'object' && !Array.isArray(this.options.FilterExperiences))
 			{
 				this.pict.Bundle._ActiveFilterState = this.pict.Bundle._ActiveFilterState || {};
@@ -598,6 +615,7 @@ class MeadowEndpointsRecordSetProvider extends libRecordSetProviderBase
 			}
 			++tmpOrdinal;
 			const tmpColumn = tmpProperties[tmpSchemaField];
+			const tmpMeadowSchemaField = tmpSchema.MeadowSchema?.Schema?.find?.((f) => f.Column === tmpSchemaField);
 			let tmpFieldFilterSchema = this._FilterSchema[tmpSchemaField];
 			if (!tmpFieldFilterSchema)
 			{
@@ -631,7 +649,7 @@ class MeadowEndpointsRecordSetProvider extends libRecordSetProviderBase
 			{
 				tmpFieldFilterSchema.AvailableClauses = [];
 			}
-			const tmpFieldFilterClauses = this.getFieldFilterClauses(tmpSchemaField, tmpColumn);
+			const tmpFieldFilterClauses = this.getFieldFilterClauses(tmpSchemaField, tmpColumn, tmpMeadowSchemaField);
 			if (Array.isArray(tmpFieldFilterClauses) && tmpFieldFilterClauses.length > 0)
 			{
 				for (const tmpFilterClause of tmpFieldFilterClauses)

package/source/services/RecordsSet-MetaController.js

@@ -96,6 +96,8 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 	 */
 
 	/**
+	 * @param {string} pRecordSet - The RecordSet name to get the configuration for.
+	 *
 	 * @return {Record<string, any>} - The registered configuration for the RecordSet
 	 */
 	getRecordSetConfiguration(pRecordSet)
@@ -103,6 +105,9 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		return this.recordSetProviderConfigurations[pRecordSet];
 	}
 
+	/**
+	 * @param {Record<string, any>} pRecordSetConfiguration - The RecordSet configuration to load.
+	 */
 	loadRecordSetConfiguration(pRecordSetConfiguration)
 	{
 		if (typeof pRecordSetConfiguration !== 'object')
@@ -208,6 +213,9 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		return tmpProvider;
 	}
 
+	/**
+	 * @param {Array<Record<string, any>>} pRecordSetConfigurationArray - An array of RecordSet configurations to load.
+	 */
 	loadRecordSetConfigurationArray(pRecordSetConfigurationArray)
 	{
 		if (!Array.isArray(pRecordSetConfigurationArray))
@@ -229,6 +237,11 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		}
 	}
 
+	/**
+	 * @param {Record<string, any> | string} pRecordSet - The RecordSet configuration or hash to load dynamically.
+	 * @param {string} [pEntity] - (optional) The Entity type to use (defaults to the RecordSet name if not provided).
+	 * @param {string} [pDefaultFilter] - (optional) The default filter to use.
+	 */
 	loadRecordSetDynamically(pRecordSet, pEntity, pDefaultFilter)
 	{
 		if (typeof(pRecordSet) === 'object')
@@ -238,6 +251,11 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 
 			return this.fable.providers[tmpRecordSetProviderHash].initializeAsync((pError) =>
 				{
+					if (pError)
+					{
+						this.log.error(`RecordSet [${pRecordSet.RecordSet}] dynamically loaded with error: ${pError.message || pError}`, { Stack: pError.stack });
+						return;
+					}
 					this.log.trace(`RecordSet [${pRecordSet.RecordSet} dynamically loaded.`);
 				})
 		}
@@ -264,6 +282,11 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 			return this.fable.providers[tmpRecordSetProviderHash].initializeAsync(
 				(pError) =>
 				{
+					if (pError)
+					{
+						this.log.error(`RecordSet [${tmpRecordSet}] dynamically loaded with error: ${pError.message || pError}`, { Stack: pError.stack });
+						return;
+					}
 					this.log.trace(`RecordSet [${tmpRecordSetConfiguration.RecordSet} dynamically loaded.`);
 				});
 		}
@@ -272,6 +295,9 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		return false;
 	}
 
+	/**
+	 * @param {Record<string, any>} pRoutePayload - The route payload containing the RecordSet and optional Entity and DefaultFilter.
+	 */
 	handleLoadDynamicRecordSetRoute(pRoutePayload)
 	{
 		if (typeof(pRoutePayload) != 'object')
@@ -287,6 +313,9 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		return this.loadRecordSetDynamically(tmpRecordSet, tmpEntity, tmpDefaultFilter);
 	}
 
+	/**
+	 * @param {import('pict-router')} pPictRouter - The Pict Router to add the routes to.
+	 */
 	addRoutes(pPictRouter)
 	{
 		pPictRouter.addRoute('/PSRS/:RecordSet/LoadDynamic', this.handleLoadDynamicRecordSetRoute.bind(this));
@@ -295,6 +324,9 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		return true;
 	}
 
+	/**
+	 * @param {string} pCapability - The capability to check for.
+	 */
 	async checkSession(pCapability)
 	{
 		for (const sessionProvider of this.sessionProviders)
@@ -307,6 +339,13 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		return true;
 	}
 
+	/**
+	 * @param {string} pNameTemplate - The name template for the record link.
+	 * @param {string} pURLTemplate - The URL template for the record link.
+	 * @param {boolean} pDefault - Whether this is a default link template.
+	 *
+	 * @return {Record<string, any>} - The link template object that was added.
+	 */
 	addRecordLinkTemplate(pNameTemplate, pURLTemplate, pDefault)
 	{
 		return this.fable.providers.RecordSetLinkManager.addRecordLinkTemplate(pNameTemplate, pURLTemplate, pDefault);

package/source/templates/Pict-Template-FilterInstanceViews.js

@@ -30,17 +30,22 @@ class PictTemplateFilterInstanceViewInstruction extends libPictTemplate
 		}
 	}
 
-	_getViewForFilterClauses(pClauses)
+	_getViewForFilterClause(pClause)
 	{
-		const tmpViewHash =`PRSP-FilterType-${pClauses.Type}`;
+		let tmpViewHash = `PRSP-FilterType-${pClause.Type}`;
+		const tmpCustomViewHash = `${tmpViewHash}-${pClause.CustomFilterViewHash}`;
+		if (tmpCustomViewHash in this.pict.views)
+		{
+			tmpViewHash = tmpCustomViewHash;
+		}
 		/** @type {import('../views/filters/RecordSet-Filter-Base.js')} */
 		let tmpView = this.pict.views[tmpViewHash];
 		if (!tmpView)
 		{
-			const tmpViewPrototype = libFilterViews[pClauses.Type] || libFilterViews.Base;
+			const tmpViewPrototype = libFilterViews[pClause.Type] || libFilterViews.Base;
 			if (!tmpViewPrototype)
 			{
-				this.pict.log.error(`Pict: Filter Instance Views Template Render: No view prototype found for filter type [${pClauses.Type}]`);
+				this.pict.log.error(`Pict: Filter Instance Views Template Render: No view prototype found for filter type [${pClause.Type}]`);
 				return null;
 			}
 			//FIXME: is this safe? will this view get rendered at other times?
@@ -103,11 +108,10 @@ class PictTemplateFilterInstanceViewInstruction extends libPictTemplate
 		const tmpClauses = this.pict.Bundle._ActiveFilterState?.[pRecord.RecordSet]?.FilterClauses || [];
 		//FIXME: lookup by hash instead?
 		for (let i = 0; i < tmpClauses.length; i++)
-		//for (const tmpClauses of this.pict.Bundle._ActiveFilterState?.[pRecord.RecordSet]?.FilterClauses || [])
 		{
 			const tmpClause = tmpClauses[i];
 			/** @type {import('../views/filters/RecordSet-Filter-Base.js')} */
-			const tmpView = this._getViewForFilterClauses(tmpClause);
+			const tmpView = this._getViewForFilterClause(tmpClause);
 			if (!tmpView)
 			{
 				continue;
@@ -182,7 +186,7 @@ class PictTemplateFilterInstanceViewInstruction extends libPictTemplate
 		{
 			const tmpClause = tmpClauses[i];
 			/** @type {import('../views/filters/RecordSet-Filter-Base.js')} */
-			const tmpView = this._getViewForFilterClauses(tmpClause);
+			const tmpView = this._getViewForFilterClause(tmpClause);
 			if (!tmpView)
 			{
 				continue;

package/source/views/RecordSet-Filters.js

@@ -148,61 +148,61 @@ const _DEFAULT_CONFIGURATION_SUBSET_Filter =
 //FIXME: export this from PSF?
 const libPictViewDynamicForm = require('pict-section-form/source/views/Pict-View-DynamicForm.js');
 
-class ViewRecordSetSUBSETFilters extends libPictView
+const DynamicInputViewSectionDefinition = (
 {
-	constructor(pFable, pOptions, pServiceHash)
-	{
-		let tmpOptions = Object.assign({}, _DEFAULT_CONFIGURATION_SUBSET_Filter, pOptions);
-		super(pFable, tmpOptions, pServiceHash);
-		/** @type {import('fable') & import('pict') & { PictSectionRecordSet: import('../Pict-Section-RecordSet.js') }} */
-		this.pict;
+	"Hash": "PSRSDynamicInputs",
+	"Name": "Custom Dynamic Inputs",
+	"ViewHash": "PSRSFilterProxyView",
 
-		const tmpDynamicInputViewSection = (
-		{
-			"Hash": "PSRSDynamicInputs",
-			"Name": "Custom Dynamic Inputs",
-			"ViewHash": "PSRSFilterProxyView",
+	"AutoMarshalDataOnSolve": true,
+	"IncludeInMetatemplateSectionGeneration": false,
 
-			"AutoMarshalDataOnSolve": true,
-			"IncludeInMetatemplateSectionGeneration": false,
-
-			"Manifests":
+	"Manifests":
+	{
+		"Section":
+		{
+			"Scope": "PSRSDynamic",
+			"Sections":
+			[
+				{
+					"Hash": "PSRSDynamicInputs",
+					"Name": "Dynamic Inputs"
+				}
+			],
+			"Descriptors":
 			{
-				"Section":
+				"PSRS.DynamicInputPlaceholder":
 				{
-					"Scope": "PSRSDynamic",
-					"Sections":
-					[
-						{
-							"Hash": "PSRSDynamicInputs",
-							"Name": "Dynamic Inputs"
-						}
-					],
-					"Descriptors":
+					"Name": "DynamicInputPlaceholder",
+					"Hash": "DynamicInputPlaceholder",
+					"DataType": "String",
+					"Macro":
 					{
-						"PSRS.DynamicInputPlaceholder":
-						{
-							"Name": "DynamicInputPlaceholder",
-							"Hash": "DynamicInputPlaceholder",
-							"DataType": "String",
-							"Macro":
-							{
-								"HTMLSelector": ""
-							},
-							"PictForm":
-							{
-								"Section": "PSRSDynamicInputs"
-							}
-						}
+						"HTMLSelector": ""
+					},
+					"PictForm":
+					{
+						"Section": "PSRSDynamicInputs"
 					}
 				}
 			}
-		});
-		if (!this.pict.views[tmpDynamicInputViewSection.ViewHash])
+		}
+	}
+});
+class ViewRecordSetSUBSETFilters extends libPictView
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		let tmpOptions = Object.assign({}, _DEFAULT_CONFIGURATION_SUBSET_Filter, pOptions);
+		super(pFable, tmpOptions, pServiceHash);
+		/** @type {import('fable') & import('pict') & { PictSectionRecordSet: import('../Pict-Section-RecordSet.js') }} */
+		this.pict;
+
+		if (!this.pict.views[DynamicInputViewSectionDefinition.ViewHash])
 		{
-			const tmpViewConfiguration = Object.assign({}, tmpDynamicInputViewSection);
+			const tmpViewConfiguration = Object.assign({}, DynamicInputViewSectionDefinition);
 			this.pict.addView(tmpViewConfiguration.ViewHash, tmpViewConfiguration, libPictViewDynamicForm);
-			this.pict.views[tmpDynamicInputViewSection.ViewHash].viewMarshalDestination = 'Bundle';
+			this.pict.views[DynamicInputViewSectionDefinition.ViewHash].viewMarshalDestination = 'Bundle';
 		}
 		for (const tmpView of Object.values(require('./filters')))
 		{
@@ -221,6 +221,25 @@ class ViewRecordSetSUBSETFilters extends libPictView
 		}
 	}
 
+	/**
+	 * @return {string} - The marshalling prefix configured for filters. Usually 'Bundle.'
+	 */
+	getInformaryAddressPrefix()
+	{
+		return `${this.pict.views[DynamicInputViewSectionDefinition.ViewHash].viewMarshalDestination}.`;
+	}
+
+	/**
+	 * @param {string} pAddress - The address of the informary to get the value from.
+	 *
+	 * @return {any} - The value at the given address, using the informary marshalling prefix.
+	 */
+	getInformaryScopedValue(pAddress)
+	{
+		const tmpCompositeAddress = `${this.getInformaryAddressPrefix()}${pAddress}`;
+		return this.pict.resolveStateFromAddress(tmpCompositeAddress);
+	}
+
 	//NOTE: two methods below copied from the pict-section-form metacontroller
 	//TODO: consider subclassing the dynamic view to somehow mark these as filter views so we can only operate on those views
 
@@ -315,6 +334,7 @@ class ViewRecordSetSUBSETFilters extends libPictView
 		{
 			tmpURL = tmpURL.replace(/\/FilteredTo\//, '');
 		}
+		this.render(undefined, undefined, { RecordSet: pRecordSet, ViewContext: pViewContext });
 		this.serializeFilterExperience(this.pict.Bundle._ActiveFilterState[pRecordSet]?.FilterClauses).then((pFilterExperienceSerialized) =>
 		{
 			if (pFilterExperienceSerialized)
@@ -342,6 +362,11 @@ class ViewRecordSetSUBSETFilters extends libPictView
 			{
 				delete tmpClause.Value;
 				delete tmpClause.Values;
+				delete tmpClause.SearchInputValue;
+				delete tmpClause.SelectedValues;
+				delete tmpClause.SearchResults;
+				delete tmpClause.SearchResultsOffset;
+				delete tmpClause.LoadMoreEnabled;
 			}
 		}
 		this.performSearch(pRecordSet, pViewContext);
@@ -428,7 +453,15 @@ class ViewRecordSetSUBSETFilters extends libPictView
 		{
 			return '';
 		}
-		return this.encode(await this.compress(JSON.stringify(pExperience)));
+		const tmpExperience = JSON.parse(JSON.stringify(pExperience));
+		for (const tmpClause of tmpExperience)
+		{
+			//FIXME: avoiding saving search results to the URL but this pattern isn't ideal
+			delete tmpClause.SearchResults;
+			delete tmpClause.SearchResultsOffset;
+			delete tmpClause.LoadMoreEnabled;
+		}
+		return this.encode(await this.compress(JSON.stringify(tmpExperience)));
 	}
 
 	/**

package/source/views/filters/RecordSet-Filter-Base.js

@@ -41,7 +41,7 @@ const _DEFAULT_CONFIGURATION_SUBSET_Filter =
 			Hash: 'PRSP-Filter-Base-Template',
 			Template: /*html*/`
 	<!-- DefaultPackage pict view template: [PRSP-Filter-Base-Template] -->
-	<div>
+	<div id="PRSP_Filter_Container_{~D:Record.Hash~}">
 		<button type="button"
 			onclick="_Pict.views['PRSP-Filters'].removeFilter(event, '{~D:Record.RecordSet~}', '{~D:Record.ViewContext~}', '{~D:Record.Hash~}');"
 			>
@@ -97,6 +97,24 @@ class ViewRecordSetSUBSETFilterBase extends libPictView
 	{
 		return 'PRSP-Filter-Base-Form';
 	}
+
+	/**
+	 * @return {string} - The prefix for the informary address.
+	 */
+	getInformaryAddressPrefix()
+	{
+		return this.pict.views['PRSP-Filters'].getInformaryAddressPrefix();
+	}
+
+	/**
+	 * @param {string} pInformaryAddress - The address of the informary to get the value from.
+	 *
+	 * @return {any} - The value at the informary address.
+	 */
+	getInformaryScopedValue(pInformaryAddress)
+	{
+		return this.pict.views['PRSP-Filters'].getInformaryScopedValue(pInformaryAddress);
+	}
 }
 
 module.exports = ViewRecordSetSUBSETFilterBase;