pict-section-recordset 1.0.24 → 1.0.26

package/source/services/RecordsSet-MetaController.js

@@ -1,18 +1,18 @@
 const libFableServiceProviderBase = require('fable-serviceproviderbase');
 
-const viewDefinitionRecordSetErrorNotFound = require('../views/error/RecordSet-Error-NotFound.json');
-const viewRecordSetList = require('../views/list/RecordSet-List.js');
-const viewRecordSetEdit = require('../views/edit/RecordSet-Edit.js');
-const viewRecordSetRead = require('../views/read/RecordSet-Read.js');
-const viewRecordSetDashboard = require('../views/dashboard/RecordSet-Dashboard.js');
+const ViewDefinitionRecordSetErrorNotFound = require('../views/error/RecordSet-Error-NotFound.json');
+const ViewRecordSetList = require('../views/list/RecordSet-List.js');
+const ViewRecordSetEdit = require('../views/edit/RecordSet-Edit.js');
+const ViewRecordSetRead = require('../views/read/RecordSet-Read.js');
+const ViewRecordSetDashboard = require('../views/dashboard/RecordSet-Dashboard.js');
 
 //_Pict.addProvider('BooksProvider', { Entity: 'Book', URLPrefix: 'http://www.datadebase.com:8086/1.0/' }, require('../source/providers/RecordSet-RecordProvider-MeadowEndpoints.js'));
-const providerBase = require('../providers/RecordSet-RecordProvider-Base.js');
-const providerMeadowEndpoints = require('../providers/RecordSet-RecordProvider-MeadowEndpoints.js');
+const ProviderBase = require('../providers/RecordSet-RecordProvider-Base.js');
+const ProviderMeadowEndpoints = require('../providers/RecordSet-RecordProvider-MeadowEndpoints.js');
 
-const providerLinkManager = require('../providers/RecordSet-Link-Manager.js');
+const ProviderLinkManager = require('../providers/RecordSet-Link-Manager.js');
 
-const providerRouter = require('../providers/RecordSet-Router.js');
+const ProviderRouter = require('../providers/RecordSet-Router.js');
 
 /** @type {Record<string, any>} */
 const _DEFAULT_CONFIGURATION =
@@ -20,6 +20,8 @@ const _DEFAULT_CONFIGURATION =
 		DefaultMeadowURLPrefix: '/1.0/'
 	};
 
+const libFormsTemplateProvider = require('pict-section-form').PictFormTemplateProvider;
+
 class RecordSetMetacontroller extends libFableServiceProviderBase
 {
 	constructor(pFable, pOptions, pServiceHash)
@@ -61,6 +63,9 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		this.manifests = { Default: this.pict.manifest };
 
 		this.has_initialized = false;
+
+		//FIXME: this duplicates a behavior in pict-section-form - figure out how we want this coupled dependency to work.
+		this.fable.addProviderSingleton('PictFormSectionDefaultTemplateProvider', libFormsTemplateProvider.default_configuration, libFormsTemplateProvider);
 	}
 
 	/*
@@ -163,7 +168,7 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 				{
 					providerConfiguration.URLPrefix = '/1.0/';
 				}
-				tmpProvider = this.recordSetProviders[pRecordSetConfiguration.RecordSet] = this.fable.addProvider(providerConfiguration.Hash, providerConfiguration, providerMeadowEndpoints);
+				tmpProvider = this.recordSetProviders[pRecordSetConfiguration.RecordSet] = this.fable.addProvider(providerConfiguration.Hash, providerConfiguration, ProviderMeadowEndpoints);
 				break;
 			default:
 			case 'Custom':
@@ -177,12 +182,12 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 					}
 					else
 					{
-						tmpProvider = this.recordSetProviders[providerConfiguration.RecordSet] = this.fable.addProvider(providerConfiguration.Hash, providerConfiguration, providerBase);
+						tmpProvider = this.recordSetProviders[providerConfiguration.RecordSet] = this.fable.addProvider(providerConfiguration.Hash, providerConfiguration, ProviderBase);
 					}
 				}
 				else
 				{
-					tmpProvider = this.recordSetProviders[providerConfiguration.RecordSet] = this.fable.addProvider(providerConfiguration.Hash, providerConfiguration, providerBase);
+					tmpProvider = this.recordSetProviders[providerConfiguration.RecordSet] = this.fable.addProvider(providerConfiguration.Hash, providerConfiguration, ProviderBase);
 				}
 				break;
 		}
@@ -302,15 +307,16 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 			return this;
 		}
 
-		this.fable.addProvider('RecordSetLinkManager', {}, providerLinkManager);
+		this.fable.addProvider('RecordSetLinkManager', {}, ProviderLinkManager);
 
 		// Add the subviews internally and externally
 		this.pict.addTemplate(require('../templates/Pict-Template-FilterView.js'));
-		this.childViews.errorNotFound = this.fable.addView('RSP-RecordSet-Error-NotFound', viewDefinitionRecordSetErrorNotFound);
-		this.childViews.list = this.fable.addView('RSP-RecordSet-List', this.options, viewRecordSetList);
-		this.childViews.edit = this.fable.addView('RSP-RecordSet-Edit', this.options, viewRecordSetEdit);
-		this.childViews.read = this.fable.addView('RSP-RecordSet-Read', this.options, viewRecordSetRead);
-		this.childViews.dashboard = this.fable.addView('RSP-RecordSet-Dashboard', this.options, viewRecordSetDashboard);
+		this.pict.addTemplate(require('../templates/Pict-Template-FilterInstanceViews.js'));
+		this.childViews.errorNotFound = this.fable.addView('RSP-RecordSet-Error-NotFound', ViewDefinitionRecordSetErrorNotFound);
+		this.childViews.list = this.fable.addView('RSP-RecordSet-List', this.options, ViewRecordSetList);
+		this.childViews.edit = this.fable.addView('RSP-RecordSet-Edit', this.options, ViewRecordSetEdit);
+		this.childViews.read = this.fable.addView('RSP-RecordSet-Read', this.options, ViewRecordSetRead);
+		this.childViews.dashboard = this.fable.addView('RSP-RecordSet-Dashboard', this.options, ViewRecordSetDashboard);
 
 		// Initialize the subviews
 		this.childViews.list.initialize();
@@ -320,6 +326,22 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 
 		// Now initialize the router
 
+		if (this.fable.settings.hasOwnProperty('Filters') && typeof this.fable.settings.Filters === 'object')
+		{
+			for (const tmpFilterKey of Object.keys(this.fable.settings.Filters))
+			{
+				this.pict.providers.FilterManager.addFilter(tmpFilterKey, this.fable.settings.Filters[tmpFilterKey]);
+			}
+		}
+
+		if (this.fable.settings.hasOwnProperty('FilterCriteria') && typeof this.fable.settings.FilterCriteria === 'object')
+		{
+			for (const tmpFilterCriterionKey of Object.keys(this.fable.settings.FilterCriteria))
+			{
+				this.pict.providers.FilterManager.addFilterCriteria(tmpFilterCriterionKey, this.fable.settings.FilterCriteria[tmpFilterCriterionKey]);
+			}
+		}
+
 		if (this.fable.settings.hasOwnProperty('DefaultRecordSetConfigurations'))
 		{
 			this.loadRecordSetConfigurationArray(this.fable.settings.DefaultRecordSetConfigurations);
@@ -346,7 +368,7 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		// Load pict-router if it isn't loaded
 		if (!('RecordSetRouter' in this.fable.providers))
 		{
-			this.fable.addProvider('RecordSetRouter', {}, providerRouter);
+			this.fable.addProvider('RecordSetRouter', {}, ProviderRouter);
 			this.fable.providers.RecordSetRouter.initialize();
 		}
 

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

@@ -0,0 +1,222 @@
+const libPictTemplate = require('pict-template');
+const libFilterViews = require('../views/filters/index.js');
+
+/**
+ * Specialized instruction for rendering the filter view and plumbing in required context.
+ *
+ * Based on the Pict base {~V:...~} template instruction.
+ */
+class PictTemplateFilterInstanceViewInstruction extends libPictTemplate
+{
+	/**
+	 * @param {Object} pFable - The Fable Framework instance
+	 * @param {Object} pOptions - The options for the service
+	 * @param {String} pServiceHash - The hash of the service
+	 */
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		super(pFable, pOptions, pServiceHash);
+
+		/** @type {any} */
+		this.log;
+
+		this.addPattern('{~FIV:', '~}');
+		this.addPattern('{~FilterInstanceViews:', '~}');
+
+
+		if (!('__TemplateOutputCache' in this.pict))
+		{
+			this.pict.__TemplateOutputCache = {};
+		}
+	}
+
+	_getViewForFilterClauses(pClauses)
+	{
+		const tmpViewHash =`PSRS-FilterType-${pClauses.Type}`; 
+		/** @type {import('../views/filters/RecordSet-Filter-Base.js')} */
+		let tmpView = this.pict.views[tmpViewHash];
+		if (!tmpView)
+		{
+			const tmpViewPrototype = libFilterViews[pClauses.Type] || libFilterViews.Base;
+			if (!tmpViewPrototype)
+			{
+				this.pict.log.error(`Pict: Filter Instance Views Template Render: No view prototype found for filter type [${pClauses.Type}]`);
+				return null;
+			}
+			//FIXME: is this safe? will this view get rendered at other times?
+			tmpView = this.pict.addView(tmpViewHash, { }, tmpViewPrototype);
+		}
+		return tmpView;
+	}
+
+	/**
+	 * Render a template expression, returning a string with the resulting content.
+	 *
+	 * @param {string} pTemplateHash - The hash contents of the template (what's between the template start and stop tags)
+	 * @param {any} pRecord - The json object to be used as the Record for the template render
+	 * @param {Array<any>} pContextArray - An array of context objects accessible from the template; safe to leave empty
+	 * @param {any} [pScope] - A sticky scope that can be used to carry state and simplify template
+	 *
+	 * @return {string} The rendered template
+	 */
+	render(pTemplateHash, pRecord, pContextArray, pScope)
+	{
+		const tmpRecordSet = pRecord.RecordSet || '';
+		if (!tmpRecordSet)
+		{
+			this.pict.log.error(`Pict: Filter Instance Views Template Render: No record set specified in record`);
+			return '';
+		}
+		const tmpRecordSetConfiguration = this.pict.PictSectionRecordSet.recordSetProviderConfigurations?.[tmpRecordSet];
+		if (!tmpRecordSetConfiguration)
+		{
+			this.pict.log.error(`Pict: Filter Instance Views Template Render: No record set configuration found for [${tmpRecordSet}]`);
+			return '';
+		}
+		let tmpViewContext = pRecord.ViewContext;
+		if (tmpViewContext)
+		{
+			tmpViewContext = tmpViewContext.trim();
+		}
+		else
+		{
+			tmpViewContext = 'Default';
+		}
+		pRecord = pRecord || {};
+		if (!pRecord.RecordSet)
+		{
+			pRecord.RecordSet = tmpRecordSet;
+		}
+		if (!pRecord.RecordSetConfiguration)
+		{
+			pRecord.RecordSetConfiguration = tmpRecordSetConfiguration;
+		}
+		if (!pRecord.ViewContext)
+		{
+			pRecord.ViewContext = pRecord.DashboardHash ? `${tmpViewContext}-${pRecord.DashboardHash}` : tmpViewContext;
+		}
+
+		let tmpRenderGUID = this.pict.getUUID();
+		let tmpResult = '';
+
+		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);
+			if (!tmpView)
+			{
+				continue;
+			}
+
+			const tmpRecord = Object.assign({}, pRecord, tmpClause);
+			//tmpRecord.ClauseAddress = `Bundle._ActiveFilterState['${pRecord.RecordSet}'].FilterClauses[${i}]`;
+			tmpRecord.ClauseAddress = `_ActiveFilterState[\`${pRecord.RecordSet}\`].FilterClauses[${i}]`;
+			tmpView.prepareRecord(tmpRecord);
+			tmpView.renderWithScope(tmpClause, '__Virtual', `__TemplateOutputCache.${tmpRenderGUID}`, tmpRecord);
+
+			tmpResult += this.pict.__TemplateOutputCache[tmpRenderGUID];
+			// TODO: Uncomment this when we like how it's working
+			//delete this.pict.__TemplateOutputCache[tmpRenderGUID];
+
+		}
+		return tmpResult;
+	}
+
+	/**
+	 * @param {string} pTemplateHash - The hash contents of the template (what's between the template start and stop tags)
+	 * @param {any} pRecord - The json object to be used as the Record for the template
+	 * @param {(pError?: Error, pResult?: string) => void} fCallback - The callback function to call with the result
+	 * @param {Array<any>} pContextArray - An array of context objects accessible from the template; safe to leave empty
+	 * @param {any} [pScope] - A sticky scope that can be used to carry state and simplify template
+	 * @return {void}
+	 */
+	renderAsync(pTemplateHash, pRecord, fCallback, pContextArray, pScope)
+	{
+		const tmpRecordSet = pRecord.RecordSet || '';
+		if (!tmpRecordSet)
+		{
+			this.pict.log.error(`Pict: Filter Instance Views Template Render: No record set specified in record`);
+			return fCallback(null, '');
+		}
+		const tmpRecordSetConfiguration = this.pict.PictSectionRecordSet.recordSetProviderConfigurations?.[tmpRecordSet];
+		if (!tmpRecordSetConfiguration)
+		{
+			this.pict.log.error(`Pict: Filter Instance Views Template Render: No record set configuration found for [${tmpRecordSet}]`);
+			return fCallback(null, '');
+		}
+		let tmpViewContext = pRecord.ViewContext;
+		if (tmpViewContext)
+		{
+			tmpViewContext = tmpViewContext.trim();
+		}
+		else
+		{
+			tmpViewContext = 'Default';
+		}
+
+		pRecord = pRecord || {};
+		if (!pRecord.RecordSet)
+		{
+			pRecord.RecordSet = tmpRecordSet;
+		}
+		if (!pRecord.RecordSetConfiguration)
+		{
+			pRecord.RecordSetConfiguration = tmpRecordSetConfiguration;
+		}
+		if (!pRecord.ViewContext)
+		{
+			pRecord.ViewContext = pRecord.DashboardHash ? `${tmpViewContext}-${pRecord.DashboardHash}` : tmpViewContext;
+		}
+		const tmpAnticipate = this.pict.newAnticipate();
+		let tmpResult = '';
+
+		const tmpClauses = this.pict.Bundle._ActiveFilterState?.[pRecord.RecordSet]?.FilterClauses || [];
+		//FIXME: lookup by hash instead?
+		for (let i = 0; i < tmpClauses.length; i++)
+		{
+			const tmpClause = tmpClauses[i];
+			/** @type {import('../views/filters/RecordSet-Filter-Base.js')} */
+			const tmpView = this._getViewForFilterClauses(tmpClause);
+			if (!tmpView)
+			{
+				continue;
+			}
+
+			const tmpRenderGUID = this.pict.getUUID();
+			tmpAnticipate.anticipate((fNext) =>
+			{
+				const tmpRecord = Object.assign({}, pRecord, tmpClause);
+				tmpRecord.ClauseAddress = `_ActiveFilterState[${pRecord.RecordSet}].FilterClauses[${i}]`;
+				tmpView.prepareRecord(tmpRecord);
+
+				return tmpView.renderWithScopeAsync(tmpClause, '__Virtual', `__TemplateOutputCache.${tmpRenderGUID}`, tmpRecord,
+					(pError, pResult) =>
+					{
+						if (pError)
+						{
+							this.log.warn(`Pict: Filter Instance Views Template Render: Error rendering view [${tmpView.Hash}]`, pError);
+							//TODO: should we fail the whole render?
+							return fNext();
+							//return fNext(pError);
+						}
+
+						tmpResult += this.pict.__TemplateOutputCache[tmpRenderGUID];
+						// TODO: Uncomment this when we like how it's working
+						//delete this.pict.__TemplateOutputCache[tmpRenderGUID];
+
+						return fNext(null);
+					});
+			});
+		}
+		return tmpAnticipate.wait((pError) =>
+		{
+			return fCallback(pError, tmpResult);
+		});
+	}
+}
+
+module.exports = PictTemplateFilterInstanceViewInstruction;

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

@@ -35,10 +35,11 @@ class PictTemplateFilterViewInstruction extends libPictTemplate
 	 * @param {string} pTemplateHash - The hash contents of the template (what's between the template start and stop tags)
 	 * @param {any} pRecord - The json object to be used as the Record for the template render
 	 * @param {Array<any>} pContextArray - An array of context objects accessible from the template; safe to leave empty
+	 * @param {any} [pScope] - A sticky scope that can be used to carry state and simplify template
 	 *
 	 * @return {string} The rendered template
 	 */
-	render(pTemplateHash, pRecord, pContextArray)
+	render(pTemplateHash, pRecord, pContextArray, pScope)
 	{
 		let [ tmpViewHash, tmpViewContext ] = pTemplateHash.split(':');
 		tmpViewHash = tmpViewHash.trim();
@@ -101,9 +102,10 @@ class PictTemplateFilterViewInstruction extends libPictTemplate
 	 * @param {any} pRecord - The json object to be used as the Record for the template
 	 * @param {(pError?: Error, pResult?: string) => void} fCallback - The callback function to call with the result
 	 * @param {Array<any>} pContextArray - An array of context objects accessible from the template; safe to leave empty
+	 * @param {any} [pScope] - A sticky scope that can be used to carry state and simplify template
 	 * @return {void}
 	 */
-	renderAsync(pTemplateHash, pRecord, fCallback, pContextArray)
+	renderAsync(pTemplateHash, pRecord, fCallback, pContextArray, pScope)
 	{
 		let [ tmpViewHash, tmpViewContext ] = pTemplateHash.split(':');
 		tmpViewHash = tmpViewHash.trim();