retold 1.0.6 → 4.0.1

package/examples/quickstart/layer4/package.json

@@ -0,0 +1,38 @@
+{
+	"name": "retold-quickstart-layer4-pict",
+	"version": "1.0.0",
+	"description": "Retold Quickstart: Layer 4 - Pict (Browser MVC with Views and Router)",
+	"main": "source/BookStore-Application.js",
+	"scripts": {
+		"postinstall": "node generate-build-config.js",
+		"build": "npx quack build && npx quack copy",
+		"start": "node server.js",
+		"demo": "npm run build && npm start"
+	},
+	"dependencies": {
+		"pict": "^1.0.343",
+		"pict-application": "^1.0.28",
+		"pict-router": "^1.0.4",
+		"pict-view": "^1.0.64",
+		"pict-provider": "^1.0.3",
+		"orator": "^5.0.2",
+		"orator-serviceserver-restify": "^2.0.5",
+		"fable": "^3.1.51"
+	},
+	"devDependencies": {
+		"quackage": "^1.0.41"
+	},
+	"copyFilesSettings": {
+		"whenFileExists": "overwrite"
+	},
+	"copyFiles": [
+		{
+			"from": "./html/*",
+			"to": "./dist/"
+		},
+		{
+			"from": "./node_modules/pict/dist/*",
+			"to": "./dist/js/"
+		}
+	]
+}

package/examples/quickstart/layer4/server.js

@@ -0,0 +1,28 @@
+// Simple static file server using Orator to serve the built Pict application
+const libFable = require('fable');
+const libOrator = require('orator');
+const libOratorServiceServerRestify = require('orator-serviceserver-restify');
+
+let _Fable = new libFable(
+	{
+		Product: 'BookStore-Server',
+		ProductVersion: '1.0.0',
+		APIServerPort: 8086
+	});
+
+_Fable.serviceManager.addServiceType('OratorServiceServer', libOratorServiceServerRestify);
+_Fable.serviceManager.instantiateServiceProvider('OratorServiceServer');
+_Fable.serviceManager.addServiceType('Orator', libOrator);
+let _Orator = _Fable.serviceManager.instantiateServiceProvider('Orator');
+
+_Orator.initialize(
+	function ()
+	{
+		_Orator.addStaticRoute(`${__dirname}/dist/`, 'index.html');
+
+		_Orator.startService(
+			function ()
+			{
+				_Fable.log.info('Open http://localhost:8086 in your browser');
+			});
+	});

package/examples/quickstart/layer4/source/BookStore-Application-Config.json

@@ -0,0 +1,15 @@
+{
+	"Name": "BookStore Pict Application",
+	"Hash": "BookStore",
+
+	"MainViewportViewIdentifier": "BookStore-Layout",
+
+	"AutoSolveAfterInitialize": true,
+	"AutoRenderMainViewportViewAfterInitialize": false,
+	"AutoRenderViewsAfterInitialize": false,
+
+	"pict_configuration":
+		{
+			"Product": "BookStore-Pict"
+		}
+}

package/examples/quickstart/layer4/source/BookStore-Application.js

@@ -0,0 +1,54 @@
+const libPictApplication = require('pict-application');
+const libPictRouter = require('pict-router');
+
+const libViewLayout = require('./views/View-Layout.js');
+const libViewHome = require('./views/View-Home.js');
+const libViewAbout = require('./views/View-About.js');
+
+class BookStoreApplication extends libPictApplication
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		super(pFable, pOptions, pServiceHash);
+
+		this.pict.addProvider('PictRouter', require('./providers/Router-Config.json'), libPictRouter);
+
+		this.pict.addView('BookStore-Layout', libViewLayout.default_configuration, libViewLayout);
+		this.pict.addView('BookStore-Home', libViewHome.default_configuration, libViewHome);
+		this.pict.addView('BookStore-About', libViewAbout.default_configuration, libViewAbout);
+	}
+
+	onAfterInitializeAsync(fCallback)
+	{
+		this.pict.AppData.BookStore =
+			{
+				Title: 'Retold BookStore',
+				Books:
+					[
+						{ Title: 'The Hobbit', Author: 'J.R.R. Tolkien', Year: 1937 },
+						{ Title: 'Dune', Author: 'Frank Herbert', Year: 1965 },
+						{ Title: 'Neuromancer', Author: 'William Gibson', Year: 1984 }
+					]
+			};
+
+		this.pict.views['BookStore-Layout'].render();
+
+		return super.onAfterInitializeAsync(fCallback);
+	}
+
+	navigateTo(pRoute)
+	{
+		this.pict.providers.PictRouter.navigate(pRoute);
+	}
+
+	showView(pViewIdentifier)
+	{
+		if (pViewIdentifier in this.pict.views)
+		{
+			this.pict.views[pViewIdentifier].render();
+		}
+	}
+}
+
+module.exports = BookStoreApplication;
+module.exports.default_configuration = require('./BookStore-Application-Config.json');

package/examples/quickstart/layer4/source/providers/Router-Config.json

@@ -0,0 +1,18 @@
+{
+	"ProviderIdentifier": "Pict-Router",
+
+	"AutoInitialize": true,
+	"AutoInitializeOrdinal": 0,
+
+	"Routes":
+	[
+		{
+			"path": "/Home",
+			"template": "{~LV:Pict.PictApplication.showView(`BookStore-Home`)~}"
+		},
+		{
+			"path": "/About",
+			"template": "{~LV:Pict.PictApplication.showView(`BookStore-About`)~}"
+		}
+	]
+}

package/examples/quickstart/layer4/source/views/View-About.js

@@ -0,0 +1,38 @@
+const libPictView = require('pict-view');
+
+const _ViewConfiguration =
+	{
+		ViewIdentifier: 'BookStore-About',
+		DefaultRenderable: 'BookStore-About-Content',
+		DefaultDestinationAddress: '#BookStore-Content',
+		AutoRender: false,
+
+		Templates:
+			[
+				{
+					Hash: 'BookStore-About-Template',
+					Template: `<h1>About</h1><p>This is a quickstart example for Retold Layer 4: Pict.</p><p>Pict provides browser-side MVC with views, templates, providers, and an application lifecycle. It uses Fable for dependency injection and service management.</p><p><a style="color:#3498db;cursor:pointer" onclick="{~P~}.PictApplication.navigateTo('/Home')">Back to Home</a></p>`
+				}
+			],
+
+		Renderables:
+			[
+				{
+					RenderableHash: 'BookStore-About-Content',
+					TemplateHash: 'BookStore-About-Template',
+					DestinationAddress: '#BookStore-Content',
+					RenderMethod: 'replace'
+				}
+			]
+	};
+
+class BookStoreAboutView extends libPictView
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		super(pFable, pOptions, pServiceHash);
+	}
+}
+
+module.exports = BookStoreAboutView;
+module.exports.default_configuration = _ViewConfiguration;

package/examples/quickstart/layer4/source/views/View-Home.js

@@ -0,0 +1,50 @@
+const libPictView = require('pict-view');
+
+const _ViewConfiguration =
+	{
+		ViewIdentifier: 'BookStore-Home',
+		DefaultRenderable: 'BookStore-Home-Content',
+		DefaultDestinationAddress: '#BookStore-Content',
+		AutoRender: false,
+
+		CSS: `
+			.bs-book-list { list-style: none; padding: 0; }
+			.bs-book-item { padding: 0.75em 1em; margin: 0.5em 0; background: #f8f9fa; border-radius: 6px; border-left: 4px solid #3498db; }
+			.bs-book-title { font-weight: 600; }
+			.bs-book-author { color: #666; }
+			.bs-book-year { color: #999; font-size: 0.9em; }
+		`,
+
+		Templates:
+			[
+				{
+					Hash: 'BookStore-Home-Template',
+					Template: `<h1>{~D:AppData.BookStore.Title~}</h1><p>A simple Pict application demonstrating views, templates, and routing.</p><h2>Book Catalog</h2><ul class="bs-book-list">{~TemplateSet:BookStore-Home-BookRow:AppData.BookStore.Books~}</ul>`
+				},
+				{
+					Hash: 'BookStore-Home-BookRow',
+					Template: `<li class="bs-book-item"><span class="bs-book-title">{~D:Record.Title~}</span> <span class="bs-book-author">by {~D:Record.Author~}</span> <span class="bs-book-year">({~D:Record.Year~})</span></li>`
+				}
+			],
+
+		Renderables:
+			[
+				{
+					RenderableHash: 'BookStore-Home-Content',
+					TemplateHash: 'BookStore-Home-Template',
+					DestinationAddress: '#BookStore-Content',
+					RenderMethod: 'replace'
+				}
+			]
+	};
+
+class BookStoreHomeView extends libPictView
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		super(pFable, pOptions, pServiceHash);
+	}
+}
+
+module.exports = BookStoreHomeView;
+module.exports.default_configuration = _ViewConfiguration;

package/examples/quickstart/layer4/source/views/View-Layout.js

@@ -0,0 +1,60 @@
+const libPictView = require('pict-view');
+
+const _ViewConfiguration =
+	{
+		ViewIdentifier: 'BookStore-Layout',
+		DefaultRenderable: 'BookStore-Layout-Shell',
+		DefaultDestinationAddress: '#BookStore-Container',
+		AutoRender: false,
+
+		CSS: `
+			body { margin: 0; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif; }
+			.bs-nav { display: flex; align-items: center; justify-content: space-between; background: #2c3e50; color: #ecf0f1; padding: 0 1.5em; height: 50px; }
+			.bs-nav a { color: #bdc3c7; text-decoration: none; padding: 0.5em 0.75em; cursor: pointer; }
+			.bs-nav a:hover { color: #fff; }
+			.bs-nav-brand { font-size: 1.2em; font-weight: 600; color: #ecf0f1; cursor: pointer; text-decoration: none; }
+			#BookStore-Content { max-width: 800px; margin: 2em auto; padding: 0 1em; }
+		`,
+
+		Templates:
+			[
+				{
+					Hash: 'BookStore-Layout-Template',
+					Template: `<div class="bs-nav"><a class="bs-nav-brand" onclick="{~P~}.PictApplication.navigateTo('/Home')">Retold BookStore</a><div><a onclick="{~P~}.PictApplication.navigateTo('/Home')">Home</a><a onclick="{~P~}.PictApplication.navigateTo('/About')">About</a></div></div><div id="BookStore-Content"></div>`
+				}
+			],
+
+		Renderables:
+			[
+				{
+					RenderableHash: 'BookStore-Layout-Shell',
+					TemplateHash: 'BookStore-Layout-Template',
+					DestinationAddress: '#BookStore-Container',
+					RenderMethod: 'replace'
+				}
+			]
+	};
+
+class BookStoreLayoutView extends libPictView
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		super(pFable, pOptions, pServiceHash);
+	}
+
+	onAfterRender()
+	{
+		this.pict.views['BookStore-Home'].render();
+		this.pict.CSSMap.injectCSS();
+
+		if (this.pict.providers.PictRouter)
+		{
+			this.pict.providers.PictRouter.resolve();
+		}
+
+		return super.onAfterRender();
+	}
+}
+
+module.exports = BookStoreLayoutView;
+module.exports.default_configuration = _ViewConfiguration;

package/examples/quickstart/layer5/README.md

@@ -0,0 +1,26 @@
+# Utility: Manyfest - Object Navigation
+
+> Retold Utility Layer — Supporting tools: Manyfest (manifest management),
+> Quackage (build), Indoctrinate (documentation), Ultravisor (process
+> supervision), CacheTrax (caching), Precedent (meta-templating), and more
+
+Manyfest provides schema-driven JSON object description, navigation, and
+validation. It is used throughout Retold for consistent data access across
+layers. Fable bundles Manyfest as a built-in service.
+
+## Run
+
+```bash
+npm install
+npm start
+```
+
+## What This Demonstrates
+
+- Defining a manifest schema with descriptors, data types, and defaults
+- Reading and writing values by dot-notation address (`Author.Name`)
+- Hash-based lookups for aliased field access (e.g. `AuthorName` -> `Author.Name`)
+- Setting values on nested paths that don't exist yet
+- Populating objects with default values from the schema
+- Validating objects against schema type constraints
+- Using Manyfest as a Fable service via `_Fable.newManyfest()`

package/examples/quickstart/layer5/index.js

@@ -0,0 +1,121 @@
+const libFable = require('fable');
+const libManyfest = require('manyfest');
+
+let _Fable = new libFable(
+	{
+		Product: 'ManyfestDemo',
+		ProductVersion: '1.0.0'
+	});
+
+// 1. Define a schema with descriptors
+let _BookManifest = new libManyfest(
+	{
+		Scope: 'Book',
+		Descriptors:
+			{
+				'IDBook':
+					{
+						Name: 'Book ID',
+						Hash: 'ID',
+						DataType: 'Integer',
+						Default: 0
+					},
+				'Title':
+					{
+						Name: 'Title',
+						Hash: 'Title',
+						DataType: 'String',
+						Default: 'Untitled'
+					},
+				'Author.Name':
+					{
+						Name: 'Author Name',
+						Hash: 'AuthorName',
+						DataType: 'String',
+						Default: 'Unknown'
+					},
+				'Author.BirthYear':
+					{
+						Name: 'Author Birth Year',
+						Hash: 'AuthorBirthYear',
+						DataType: 'Integer',
+						Default: 0
+					},
+				'Genre':
+					{
+						Name: 'Genre',
+						Hash: 'Genre',
+						DataType: 'String',
+						Default: 'Fiction'
+					}
+			}
+	});
+
+// 2. Create a book object
+let tmpBook =
+	{
+		IDBook: 1,
+		Title: 'The Hobbit',
+		Author:
+			{
+				Name: 'J.R.R. Tolkien',
+				BirthYear: 1892
+			},
+		Genre: 'Fantasy'
+	};
+
+_Fable.log.info('--- Manyfest Object Navigation Demo ---');
+
+// 3. Read values by address (dot notation)
+_Fable.log.info(`Title: ${_BookManifest.getValueAtAddress(tmpBook, 'Title')}`);
+_Fable.log.info(`Author: ${_BookManifest.getValueAtAddress(tmpBook, 'Author.Name')}`);
+_Fable.log.info(`Birth Year: ${_BookManifest.getValueAtAddress(tmpBook, 'Author.BirthYear')}`);
+
+// 4. Read values by hash (aliases)
+_Fable.log.info(`By hash 'AuthorName': ${_BookManifest.getValueByHash(tmpBook, 'AuthorName')}`);
+_Fable.log.info(`By hash 'ID': ${_BookManifest.getValueByHash(tmpBook, 'ID')}`);
+
+// 5. Write values by address
+_BookManifest.setValueAtAddress(tmpBook, 'Title', 'The Hobbit (Revised Edition)');
+_Fable.log.info(`Updated title: ${_BookManifest.getValueAtAddress(tmpBook, 'Title')}`);
+
+// 6. Write nested values that don't exist yet
+_BookManifest.setValueAtAddress(tmpBook, 'Publisher.Name', 'Allen & Unwin');
+_Fable.log.info(`Publisher: ${_BookManifest.getValueAtAddress(tmpBook, 'Publisher.Name')}`);
+
+// 7. Populate defaults for missing fields
+let tmpEmptyBook = { IDBook: 42 };
+_Fable.log.info('\nBefore populate defaults:');
+_Fable.log.info(`  Has Title property: ${'Title' in tmpEmptyBook}`);
+_Fable.log.info(`  Has Author.Name property: ${tmpEmptyBook.Author !== undefined}`);
+
+_BookManifest.populateDefaults(tmpEmptyBook);
+_Fable.log.info('After populate defaults:');
+_Fable.log.info(`  Title: ${tmpEmptyBook.Title}`);
+_Fable.log.info(`  Author.Name: ${tmpEmptyBook.Author ? tmpEmptyBook.Author.Name : 'N/A'}`);
+_Fable.log.info(`  Genre: ${tmpEmptyBook.Genre}`);
+
+// 8. Validate an object
+let tmpValidation = _BookManifest.validate(tmpBook);
+_Fable.log.info(`\nValidation of full book: ${tmpValidation.Error ? 'INVALID' : 'VALID'}`);
+if (tmpValidation.Errors.length > 0)
+{
+	_Fable.log.info(`  Errors: ${tmpValidation.Errors.join(', ')}`);
+}
+
+// 9. Manyfest is also available as a Fable service
+let tmpManifest = _Fable.newManyfest(
+	{
+		Scope: 'Config',
+		Descriptors:
+			{
+				'Database.Host': { Name: 'DB Host', DataType: 'String', Default: 'localhost' },
+				'Database.Port': { Name: 'DB Port', DataType: 'Integer', Default: 3306 }
+			}
+	});
+let tmpConfig = {};
+tmpManifest.populateDefaults(tmpConfig);
+_Fable.log.info(`\nFable Manyfest service - DB Host: ${tmpManifest.getValueAtAddress(tmpConfig, 'Database.Host')}`);
+_Fable.log.info(`Fable Manyfest service - DB Port: ${tmpManifest.getValueAtAddress(tmpConfig, 'Database.Port')}`);
+
+_Fable.log.info('\n--- Manyfest Demo Complete ---');