retold 1.0.6 → 4.0.1

package/examples/quickstart/layer2/package.json

@@ -0,0 +1,17 @@
+{
+	"name": "retold-quickstart-layer2-meadow",
+	"version": "1.0.0",
+	"description": "Retold Quickstart: Layer 2 - Meadow (Data Access with MySQL)",
+	"main": "index.js",
+	"scripts": {
+		"setup": "node setup-database.js",
+		"start": "node index.js",
+		"demo": "npm run setup && npm start"
+	},
+	"dependencies": {
+		"fable": "^3.1.51",
+		"meadow": "^2.0.18",
+		"meadow-connection-mysql": "^1.0.6",
+		"mysql2": "^3.6.3"
+	}
+}

package/examples/quickstart/layer2/setup-database.js

@@ -0,0 +1,61 @@
+// Setup script: creates the database and table for the Meadow example.
+const libMySQL = require('mysql2');
+
+const MYSQL_CONFIG =
+	{
+		host: '127.0.0.1',
+		port: 3306,
+		user: 'root',
+		password: '123456789'
+	};
+
+const tmpConnection = libMySQL.createConnection(MYSQL_CONFIG);
+
+const tmpStatements =
+	[
+		`CREATE DATABASE IF NOT EXISTS retold_quickstart;`,
+		`USE retold_quickstart;`,
+		`CREATE TABLE IF NOT EXISTS Book
+		(
+			IDBook INT UNSIGNED NOT NULL AUTO_INCREMENT,
+			GUIDBook CHAR(36) DEFAULT '0x0',
+			CreateDate DATETIME,
+			CreatingIDUser INT NOT NULL DEFAULT 0,
+			UpdateDate DATETIME,
+			UpdatingIDUser INT NOT NULL DEFAULT 0,
+			Deleted TINYINT NOT NULL DEFAULT 0,
+			DeletingIDUser INT NOT NULL DEFAULT 0,
+			DeleteDate DATETIME,
+			Title CHAR(200) NOT NULL DEFAULT '',
+			Author CHAR(200) NOT NULL DEFAULT '',
+			YearPublished INT NOT NULL DEFAULT 0,
+			PRIMARY KEY (IDBook)
+		) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;`
+	];
+
+let tmpIndex = 0;
+
+function runNext()
+{
+	if (tmpIndex >= tmpStatements.length)
+	{
+		console.log('Database setup complete.');
+		tmpConnection.end();
+		return;
+	}
+
+	tmpConnection.query(tmpStatements[tmpIndex],
+		function (pError)
+		{
+			if (pError)
+			{
+				console.error(`Error running statement ${tmpIndex}:`, pError.message);
+				tmpConnection.end();
+				process.exit(1);
+			}
+			tmpIndex++;
+			runNext();
+		});
+}
+
+runNext();

package/examples/quickstart/layer3/README.md

@@ -0,0 +1,39 @@
+# Layer 4: Orator - REST API Server
+
+> Retold Layer 4 — API Server: HTTP lifecycle management, middleware,
+> content negotiation, static file serving, with pluggable server implementations
+> (Restify, IPC)
+
+Orator provides a consistent HTTP server interface. This example uses the
+Restify service server for production HTTP. Orator also supports an IPC mode
+for in-process testing without network overhead.
+
+In a full Retold application, Layer 3 (Meadow-Endpoints) auto-generates CRUD
+routes from your Meadow entities and wires them to Orator. This example shows
+Orator with manually defined routes.
+
+## Run
+
+```bash
+npm install
+npm start
+```
+
+Then test with curl:
+
+```bash
+curl http://localhost:8080/health
+curl http://localhost:8080/api/books
+curl http://localhost:8080/api/books/1
+curl -X POST http://localhost:8080/api/books \
+  -H "Content-Type: application/json" \
+  -d '{"title":"Snow Crash","author":"Neal Stephenson","year":1992}'
+```
+
+## What This Demonstrates
+
+- Creating an HTTP server with Orator and the Restify service server
+- Defining GET and POST routes with request/response handling
+- Route parameters and JSON responses
+- Body parsing middleware (postWithBodyParser)
+- Starting and stopping the server lifecycle

package/examples/quickstart/layer3/index.js

@@ -0,0 +1,91 @@
+const libFable = require('fable');
+const libOrator = require('orator');
+const libOratorServiceServerRestify = require('orator-serviceserver-restify');
+
+// 1. Create Fable
+let _Fable = new libFable(
+	{
+		Product: 'BookStore-API',
+		ProductVersion: '1.0.0',
+		APIServerPort: 8080
+	});
+
+// 2. Register the Restify service server, then Orator
+_Fable.serviceManager.addServiceType('OratorServiceServer', libOratorServiceServerRestify);
+_Fable.serviceManager.instantiateServiceProvider('OratorServiceServer');
+_Fable.serviceManager.addServiceType('Orator', libOrator);
+let _Orator = _Fable.serviceManager.instantiateServiceProvider('Orator');
+
+// In-memory book store for this example
+let _Books =
+	[
+		{ id: 1, title: 'The Hobbit', author: 'J.R.R. Tolkien', year: 1937 },
+		{ id: 2, title: 'Dune', author: 'Frank Herbert', year: 1965 },
+		{ id: 3, title: 'Neuromancer', author: 'William Gibson', year: 1984 }
+	];
+let _NextID = 4;
+
+// 3. Initialize and start the server
+_Orator.initialize(
+	function ()
+	{
+		// 4. Define routes
+
+		// Health check
+		_Orator.serviceServer.get('/health',
+			function (pRequest, pResponse, fNext)
+			{
+				pResponse.send({ status: 'ok', product: _Fable.settings.Product });
+				return fNext();
+			});
+
+		// List all books
+		_Orator.serviceServer.get('/api/books',
+			function (pRequest, pResponse, fNext)
+			{
+				pResponse.send(_Books);
+				return fNext();
+			});
+
+		// Get a single book by ID
+		_Orator.serviceServer.get('/api/books/:id',
+			function (pRequest, pResponse, fNext)
+			{
+				let tmpBook = _Books.find((b) => b.id === parseInt(pRequest.params.id));
+				if (!tmpBook)
+				{
+					pResponse.send(404, { error: 'Book not found' });
+					return fNext();
+				}
+				pResponse.send(tmpBook);
+				return fNext();
+			});
+
+		// Create a book (with body parser for JSON)
+		_Orator.serviceServer.postWithBodyParser('/api/books',
+			function (pRequest, pResponse, fNext)
+			{
+				let tmpBook =
+					{
+						id: _NextID++,
+						title: pRequest.body.title || 'Untitled',
+						author: pRequest.body.author || 'Unknown',
+						year: pRequest.body.year || 0
+					};
+				_Books.push(tmpBook);
+				_Fable.log.info(`Created book: "${tmpBook.title}"`);
+				pResponse.send(201, tmpBook);
+				return fNext();
+			});
+
+		// 5. Start listening
+		_Orator.startService(
+			function ()
+			{
+				_Fable.log.info('Try these commands:');
+				_Fable.log.info('  curl http://localhost:8080/health');
+				_Fable.log.info('  curl http://localhost:8080/api/books');
+				_Fable.log.info('  curl http://localhost:8080/api/books/1');
+				_Fable.log.info('  curl -X POST http://localhost:8080/api/books -H "Content-Type: application/json" -d \'{"title":"Snow Crash","author":"Neal Stephenson","year":1992}\'');
+			});
+	});