pict-section-recordset 1.0.1 → 1.0.3

package/source/services/RecordsSet-MetaController.js

@@ -9,16 +9,21 @@ const viewRecordSetDashboard = require('../views/dashboard/RecordSet-Dashboard.j
 const providerBase = require('../providers/RecordSet-RecordProvider-Base.js');
 const providerMeadowEndpoints = require('../providers/RecordSet-RecordProvider-MeadowEndpoints.js');
 
-const providerPictRouter = require('pict-router');
+const providerLinkManager = require('../providers/RecordSet-Link-Manager.js');
 
-const { type } = require('os');
+const providerRouter = require('../providers/RecordSet-Router.js');
+
+const _DEFAULT_CONFIGURATION =
+	{
+		DefaultMeadowURLPrefix: '/1.0/'
+	};
 
 class RecordSetMetacontroller extends libFableServiceProviderBase
 {
 	constructor(pFable, pOptions, pServiceHash)
 	{
-		// Intersect default options, parent constructor, service information
-		super(pFable, pOptions, pServiceHash);
+		let tmpOptions = Object.assign({}, _DEFAULT_CONFIGURATION, pOptions);
+		super(pFable, tmpOptions, pServiceHash);
 
 		/** @type {import('pict') & { addAndInstantiateSingletonService: (hash: string, options: any, prototype: any) => any }} */
 		this.fable;
@@ -81,6 +86,8 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 			return false;
 		}
 
+		let tmpProvider = false;
+
 		const providerConfiguration = Object.assign({}, {Hash: `RSP-Provider-${pRecordSetConfiguration.RecordSet}`}, pRecordSetConfiguration);
 		this.recordSetProviderConfigurations[providerConfiguration.RecordSet] = providerConfiguration;
 
@@ -98,7 +105,7 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 					providerConfiguration.Entity = pRecordSetConfiguration.RecordSet;
 				}
 				// Default the URLPrefix to the base URLPrefix
-				if (`URLPrefix` in pRecordSetConfiguration)
+				if (`RecordSetURLPrefix` in pRecordSetConfiguration)
 				{
 					providerConfiguration.URLPrefix = pRecordSetConfiguration.RecordSetURLPrefix;
 				}
@@ -106,7 +113,7 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 				{
 					providerConfiguration.URLPrefix = '/1.0/';
 				}
-				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':
@@ -116,21 +123,21 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 					if (!(providerConfiguration.ProviderHash in this.fable.servicesMap))
 					{
 						this.fable.log.error(`RecordSetMetacontroller: ${this.UUID} loadRecordSetConfiguration called with invalid configuration. ProviderHash ${providerConfiguration.ProviderHash} not found.  Falling back to base.`);
-						this.recordSetProviders[providerConfiguration.RecordSet] = this.fable.servicesMap[providerConfiguration.ProviderHash];
+						tmpProvider = this.recordSetProviders[providerConfiguration.RecordSet] = this.fable.servicesMap[providerConfiguration.ProviderHash];
 					}
 					else
 					{
-						this.recordSetProviders[providerConfiguration.RecordSet] = this.fable.addProvider(providerConfiguration.Hash, providerConfiguration, providerBase);
+						tmpProvider = this.recordSetProviders[providerConfiguration.RecordSet] = this.fable.addProvider(providerConfiguration.Hash, providerConfiguration, providerBase);
 					}
 				}
 				else
 				{
-					this.recordSetProviders[providerConfiguration.RecordSet] = this.fable.addProvider(providerConfiguration.Hash, providerConfiguration, providerBase);
+					tmpProvider = this.recordSetProviders[providerConfiguration.RecordSet] = this.fable.addProvider(providerConfiguration.Hash, providerConfiguration, providerBase);
 				}
 				break;
 		}
 
-		return true;
+		return tmpProvider;
 	}
 
 	loadRecordSetConfigurationArray(pRecordSetConfigurationArray)
@@ -154,6 +161,77 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		}
 	}
 
+	loadRecordSetDynamcally(pRecordSet, pEntity, pDefaultFilter)
+	{
+		if (typeof(pRecordSet) === 'object')
+		{
+			const tmpRecordSetProviderHash = `RSP-Provider-${pRecordSet.RecordSet}`;
+			this.loadRecordSetConfiguration(pRecordSet);
+
+			return this.fable.providers[tmpRecordSetProviderHash].initializeAsync((pError) =>
+				{
+					this.log.trace(`RecordSet [${pRecordSet.RecordSet} dynamically loaded.`);
+				})
+		}
+
+		if (typeof(pRecordSet) === 'string')
+		{
+			const tmpRecordSet = pRecordSet;
+			const tmpRecordSetProviderHash = `RSP-Provider-${tmpRecordSet}`;
+
+			const tmpEntity = (typeof(pEntity) === 'string') ? pEntity : tmpRecordSet;
+			const tmpDefaultFilter = (typeof(pDefaultFilter) === 'string') ? pDefaultFilter : '';
+			const tmpRecordSetConfiguration = {
+				"RecordSet": tmpRecordSet,
+
+
+				"RecordSetType": "MeadowEndpoint",
+				"RecordSetMeadowEntity": tmpEntity,
+				"RecordSetDefaultFilter": tmpDefaultFilter,
+
+				"RecordSetURLPrefix": "/1.0/"
+			};
+
+			this.loadRecordSetConfiguration(tmpRecordSetConfiguration);
+			return this.fable.providers[tmpRecordSetProviderHash].initializeAsync(
+				(pError) =>
+				{
+					this.log.trace(`RecordSet [${tmpRecordSetConfiguration.RecordSet} dynamically loaded.`);
+				});
+		}
+
+		this.log.error(`RecordSet MetaController loadRecordSetDynamically called with invalid parameter (expected an Object or String - parameter was ${typeof(pRecordSet)}.`);
+		return false;
+	}
+
+	handleLoadDynamicRecordSetRoute(pRoutePayload)
+	{
+		if (typeof(pRoutePayload) != 'object')
+		{
+			throw new Error(`Pict RecordSet List view route handler called with invalid route payload.`);
+		}
+
+		const tmpRecordSet = pRoutePayload.data.RecordSet;
+
+		const tmpEntity = pRoutePayload.data.Entity ? pRoutePayload.data.Entity : tmpRecordSet;
+		const tmpDefaultFilter = pRoutePayload.data.DefaultFilter ? pRoutePayload.data.DefaultFilter : '';
+
+		return this.loadRecordSetDynamcally(tmpRecordSet, tmpEntity, tmpDefaultFilter);
+	}
+
+	addRoutes(pPictRouter)
+	{
+		pPictRouter.addRoute('/PSRS/:RecordSet/LoadDynamic', this.handleLoadDynamicRecordSetRoute.bind(this));
+		pPictRouter.addRoute('/PSRS/:RecordSet/LoadDynamic/:Entity', this.handleLoadDynamicRecordSetRoute.bind(this));
+		pPictRouter.addRoute('/PSRS/:RecordSet/LoadDynamic/:Entity/:DefaultFilter', this.handleLoadDynamicRecordSetRoute.bind(this));
+		return true;
+	}
+
+	addRecordLinkTemplate(pNameTemplate, pURLTemplate, pDefault)
+	{
+		return this.fable.providers.RecordSetLinkManager.addRecordLinkTemplate(pNameTemplate, pURLTemplate, pDefault);
+	}
+
 	initialize()
 	{
 		if (this.has_initialized)
@@ -162,6 +240,8 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 			return this;
 		}
 
+		this.fable.addProvider('RecordSetLinkManager', {}, providerLinkManager);
+
 		// Add the subviews internally and externally
 		this.childViews.list = this.fable.addView('RSP-RecordSet-List', this.options, viewRecordSetList);
 		this.childViews.edit = this.fable.addView('RSP-RecordSet-Edit', this.options, viewRecordSetEdit);
@@ -174,23 +254,26 @@ class RecordSetMetacontroller extends libFableServiceProviderBase
 		this.childViews.read.initialize();
 		this.childViews.dashboard.initialize();
 
+		// Now initialize the router
+
 		if (this.fable.settings.hasOwnProperty('DefaultRecordSetConfigurations'))
 		{
 			this.loadRecordSetConfigurationArray(this.fable.settings.DefaultRecordSetConfigurations);
 		}
 
+		this.has_initialized = true;
+
 		// Load pict-router if it isn't loaded
-		if (!('Pict-Router' in this.fable.providers))
+		if (!('RecordSetRouter' in this.fable.providers))
 		{
-			this.fable.addProvider('Pict-Router', {}, providerPictRouter);
+			this.fable.addProvider('RecordSetRouter', {}, providerRouter);
+			this.fable.providers.RecordSetRouter.initialize();
 		}
 
-		this.has_initialized = true;
-
-		return this;
+		return true;
 	}
 }
 
 module.exports = RecordSetMetacontroller;
 
-RecordSetMetacontroller.default_configuration = { };
+RecordSetMetacontroller.default_configuration = _DEFAULT_CONFIGURATION;

package/source/views/RecordSet-RecordBaseView.js

@@ -0,0 +1,84 @@
+const libPictView = require('pict-view');
+
+const _DEFAULT_CONFIGURATION_Base_View = (
+{
+	ViewIdentifier: 'PRSP-RecordSet-View-Base',
+
+	DefaultRenderable: 'PRSP_Base_Recordset',
+	DefaultDestinationAddress: '#PictRecordSetContainer',
+	DefaultTemplateRecordAddress: false,
+
+	// If this is set to true, when the App initializes this will.
+	// While the App initializes, initialize will be called.
+	AutoInitialize: false,
+	AutoInitializeOrdinal: 0,
+
+	// If this is set to true, when the App autorenders (on load) this will.
+	// After the App initializes, render will be called.
+	AutoRender: false,
+	AutoRenderOrdinal: 0,
+
+	AutoSolveWithApp: false,
+	AutoSolveOrdinal: 0,
+
+	CSS: false,
+	CSSPriority: 500,
+
+	Templates:
+		[
+			{
+			Hash: 'PRSP-Base-View-Template',
+			Template: /*html*/`
+<!-- DefaultPackage pict view template: [PRSP-Base-View-Template] -->
+<!--
+	If this is being rendered, the RecordSet view has not taken control of its render function.
+	While the view may not need custom templating it is strongly encouraged to still override 
+	the template and put informative messaging into an HTML comment.
+
+Record JSON:
+\`\`\`json
+{~DataJson:Record~}
+\`\`\`
+--!
+<!-- DefaultPackage end view template:  [PRSP-Base-View-Template] -->
+		`
+			}
+		],
+
+		Renderables:
+		[
+			{
+				RenderableHash: 'PRSP_Base_Recordset',
+				TemplateHash: 'PRSP-Base-View-Template',
+				DestinationAddress: '#PictRecordSetContainer',
+				RenderMethod: 'replace'
+			}
+		],
+
+	Manifests: {}
+});
+
+class viewPictSectionRecordSetViewBase extends libPictView
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		let tmpOptions = Object.assign({}, _DEFAULT_CONFIGURATION_Base_View, pOptions);
+		super(pFable, tmpOptions, pServiceHash);
+		/** @type {import('pict') & {
+		 *      log: any,
+		 *      instantiateServiceProviderWithoutRegistration: (hash: String) => any,
+		 *      PictSectionRecordSet: InstanceType<import('../Pict-Section-RecordSet.js')> }
+		 *  } */
+		this.pict;
+	}
+
+	addRoutes(pPictRouter)
+	{
+		this.pict.log.trace(`View [${this.options.ViewIdentifier}]::[${this.Hash}] addRoutes called.`);
+		return true;
+	}
+}
+
+module.exports = viewPictSectionRecordSetViewBase;
+
+module.exports.default_configuration = _DEFAULT_CONFIGURATION_Base_View;

package/source/views/RecordsSet-MacroView.js

@@ -0,0 +1,63 @@
+const libPictView = require('pict-view');
+
+const _DEFAULT_CONFIGURATION_Dashboard_HeaderDashboard = (
+{
+	ViewIdentifier: 'PRSP-Main',
+
+	DefaultRenderable: 'PRSP_Main_Container',
+	DefaultDestinationAddress: '#PictRecordSetContainer',
+	DefaultTemplateRecordAddress: false,
+
+	// If this is set to true, when the App initializes this will.
+	// While the App initializes, initialize will be called.
+	AutoInitialize: false,
+	AutoInitializeOrdinal: 0,
+
+	// If this is set to true, when the App autorenders (on load) this will.
+	// After the App initializes, render will be called.
+	AutoRender: false,
+	AutoRenderOrdinal: 0,
+
+	AutoSolveWithApp: false,
+	AutoSolveOrdinal: 0,
+
+	CSS: false,
+	CSSPriority: 500,
+
+	Templates:
+		[
+			{
+			Hash: 'PRSP-Main-Container-Template',
+			Template: /*html*/`
+<!-- DefaultPackage pict view template: [PRSP-Main-Container-Template] -->
+<!-- DefaultPackage end view template:  [PRSP-Main-Container-Template] -->
+		`
+			}
+		],
+
+		Renderables:
+		[
+			{
+				RenderableHash: 'PRSP_Renderable_HeaderDashboard',
+				TemplateHash: 'PRSP-Main-Container-Template',
+				DestinationAddress: '#PRSP_Main_Container',
+				RenderMethod: 'replace'
+			}
+		],
+
+	Manifests: {}
+});
+
+class viewPictSectionRecordSetMain extends libPictView
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		let tmpOptions = Object.assign({}, _DEFAULT_CONFIGURATION_Dashboard_HeaderDashboard, pOptions);
+		super(pFable, tmpOptions, pServiceHash);
+	}
+}
+
+module.exports = viewPictSectionRecordSetMain;
+
+module.exports.default_configuration = _DEFAULT_CONFIGURATION_Dashboard_HeaderDashboard;
+

package/source/views/dashboard/RecordSet-Dashboard.js

@@ -1,4 +1,4 @@
-const libPictView = require('pict-view');
+const libPictRecordSetRecordView = require('../RecordSet-RecordBaseView.js');
 
 const _DEFAULT_CONFIGURATION__Dashboard = (
   {
@@ -48,7 +48,7 @@ const _DEFAULT_CONFIGURATION__Dashboard = (
     Manifests: {}
   });
 
-class viewRecordSetDashboard extends libPictView
+class viewRecordSetDashboard extends libPictRecordSetRecordView
 {
   constructor(pFable, pOptions, pServiceHash)
   {

package/source/views/edit/RecordSet-Edit.js

@@ -1,4 +1,4 @@
-const libPictView = require('pict-view');
+const libPictRecordSetRecordView = require('../RecordSet-RecordBaseView.js');
 
 const _DEFAULT_CONFIGURATION__Edit = (
   {
@@ -48,7 +48,7 @@ const _DEFAULT_CONFIGURATION__Edit = (
     Manifests: {}
   });
 
-class viewRecordSetEdit extends libPictView
+class viewRecordSetEdit extends libPictRecordSetRecordView
 {
   constructor(pFable, pOptions, pServiceHash)
   {

package/source/views/list/RecordSet-List-PaginationBottom.js

@@ -1,64 +1,64 @@
 const libPictView = require('pict-view');
 
 const _DEFAULT_CONFIGURATION_List_PaginationBottom = (
-  {
-    ViewIdentifier: 'PRSP-List-PaginationBottom',
+	{
+		ViewIdentifier: 'PRSP-List-PaginationBottom',
 
-    DefaultRenderable: 'PRSP_Renderable_PaginationBottom',
-    DefaultDestinationAddress: '#PRSP_PaginationBottom_Container',
-    DefaultTemplateRecordAddress: false,
+		DefaultRenderable: 'PRSP_Renderable_PaginationBottom',
+		DefaultDestinationAddress: '#PRSP_PaginationBottom_Container',
+		DefaultTemplateRecordAddress: false,
 
-    // If this is set to true, when the App initializes this will.
-    // While the App initializes, initialize will be called.
-    AutoInitialize: false,
-    AutoInitializeOrdinal: 0,
+		// If this is set to true, when the App initializes this will.
+		// While the App initializes, initialize will be called.
+		AutoInitialize: false,
+		AutoInitializeOrdinal: 0,
 
-    // If this is set to true, when the App autorenders (on load) this will.
-    // After the App initializes, render will be called.
-    AutoRender: false,
-    AutoRenderOrdinal: 0,
+		// If this is set to true, when the App autorenders (on load) this will.
+		// After the App initializes, render will be called.
+		AutoRender: false,
+		AutoRenderOrdinal: 0,
 
-    AutoSolveWithApp: false,
-    AutoSolveOrdinal: 0,
+		AutoSolveWithApp: false,
+		AutoSolveOrdinal: 0,
 
-    CSS: false,
-    CSSPriority: 500,
+		CSS: false,
+		CSSPriority: 500,
 
-    Templates:
-      [
-        {
-          Hash: 'PRSP-List-PaginationBottom-Template',
-          Template: /*html*/`
+		Templates:
+			[
+				{
+					Hash: 'PRSP-List-PaginationBottom-Template',
+					Template: /*html*/`
 	<!-- DefaultPackage pict view template: [PRSP-List-PaginationBottom-Template] -->
-  <nav id="RSP_Lower_Pagination_Container">
-    {~T:PRSP-List-Pagination-Template-Description~}
+	<nav id="RSP_Lower_Pagination_Container">
+	{~T:PRSP-List-Pagination-Template-Description~}
 		{~T:PRSP-List-Pagination-Template-Buttons~}
 	</nav>
 	<!-- DefaultPackage end view template:  [PRSP-List-PaginationBottom-Template] -->
 	`
-        }
-      ],
+				}
+			],
 
-    Renderables:
-      [
-        {
-          RenderableHash: 'PRSP_Renderable_PaginationBottom',
-          TemplateHash: 'PRSP-List-PaginationBottom-Template',
-          DestinationAddress: '#PRSP_PaginationBottom_Container',
-          RenderMethod: 'replace'
-        }
-      ],
+		Renderables:
+			[
+				{
+					RenderableHash: 'PRSP_Renderable_PaginationBottom',
+					TemplateHash: 'PRSP-List-PaginationBottom-Template',
+					DestinationAddress: '#PRSP_PaginationBottom_Container',
+					RenderMethod: 'replace'
+				}
+			],
 
-    Manifests: {}
-  });
+		Manifests: {}
+	});
 
 class viewRecordSetListPaginationBottom extends libPictView
 {
-  constructor(pFable, pOptions, pServiceHash)
-  {
-    let tmpOptions = Object.assign({}, _DEFAULT_CONFIGURATION_List_PaginationBottom, pOptions);
-    super(pFable, tmpOptions, pServiceHash);
-  }
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		let tmpOptions = Object.assign({}, _DEFAULT_CONFIGURATION_List_PaginationBottom, pOptions);
+		super(pFable, tmpOptions, pServiceHash);
+	}
 }
 
 module.exports = viewRecordSetListPaginationBottom;