retold-data-service 2.0.13 → 2.0.16

package/source/services/stricture/Stricture-Command-Generate-DictionaryCSV.js

@@ -0,0 +1,14 @@
+/**
+ * Stricture Command - Generate Dictionary CSV
+ *
+ * POST /1.0/Retold/Stricture/Generate/DictionaryCSV
+ *
+ * Accepts a compiled stricture model and returns a CSV data dictionary.
+ *
+ * Body: { "Model": { "Tables": { ... }, ... } }
+ * Returns: { "Files": { "DataDictionary.csv": "..." } }
+ */
+module.exports = function(pStrictureService, pOratorServiceServer)
+{
+	pStrictureService.registerGenerateEndpoint(pOratorServiceServer, 'DictionaryCSV', require('stricture/source/Stricture-Generate-DictionaryCSV.js'));
+};

package/source/services/stricture/Stricture-Command-Generate-LaTeX.js

@@ -0,0 +1,14 @@
+/**
+ * Stricture Command - Generate LaTeX Documentation
+ *
+ * POST /1.0/Retold/Stricture/Generate/LaTeX
+ *
+ * Accepts a compiled stricture model and returns LaTeX documentation files.
+ *
+ * Body: { "Model": { "Tables": { ... }, ... } }
+ * Returns: { "Files": { "filename.tex": "..." } }
+ */
+module.exports = function(pStrictureService, pOratorServiceServer)
+{
+	pStrictureService.registerGenerateEndpoint(pOratorServiceServer, 'LaTeX', require('stricture/source/Stricture-Generate-LaTeX.js'));
+};

package/source/services/stricture/Stricture-Command-Generate-Markdown.js

@@ -0,0 +1,14 @@
+/**
+ * Stricture Command - Generate Markdown Documentation
+ *
+ * POST /1.0/Retold/Stricture/Generate/Markdown
+ *
+ * Accepts a compiled stricture model and returns Markdown documentation files.
+ *
+ * Body: { "Model": { "Tables": { ... }, ... } }
+ * Returns: { "Files": { "Dictionary.md": "...", "Model-Book.md": "...", "ModelChangeTracking.md": "..." } }
+ */
+module.exports = function(pStrictureService, pOratorServiceServer)
+{
+	pStrictureService.registerGenerateEndpoint(pOratorServiceServer, 'Markdown', require('stricture/source/Stricture-Generate-Markdown.js'));
+};

package/source/services/stricture/Stricture-Command-Generate-Meadow.js

@@ -0,0 +1,14 @@
+/**
+ * Stricture Command - Generate Meadow
+ *
+ * POST /1.0/Retold/Stricture/Generate/Meadow
+ *
+ * Accepts a compiled stricture model and returns per-entity Meadow schema JSON files.
+ *
+ * Body: { "Model": { "Tables": { ... }, ... } }
+ * Returns: { "Files": { "ModelBook.json": "{...}", "ModelAuthor.json": "{...}" } }
+ */
+module.exports = function(pStrictureService, pOratorServiceServer)
+{
+	pStrictureService.registerGenerateEndpoint(pOratorServiceServer, 'Meadow', require('stricture/source/Stricture-Generate-Meadow.js'));
+};

package/source/services/stricture/Stricture-Command-Generate-ModelGraph.js

@@ -0,0 +1,14 @@
+/**
+ * Stricture Command - Generate Model Graph
+ *
+ * POST /1.0/Retold/Stricture/Generate/ModelGraph
+ *
+ * Accepts a compiled stricture model and returns a GraphViz DOT relationship diagram.
+ *
+ * Body: { "Model": { "Tables": { ... }, ... } }
+ * Returns: { "Files": { "Model-Relationships.dot": "digraph ..." } }
+ */
+module.exports = function(pStrictureService, pOratorServiceServer)
+{
+	pStrictureService.registerGenerateEndpoint(pOratorServiceServer, 'ModelGraph', require('stricture/source/Stricture-Generate-ModelGraph.js'));
+};

package/source/services/stricture/Stricture-Command-Generate-MySQL.js

@@ -0,0 +1,14 @@
+/**
+ * Stricture Command - Generate MySQL
+ *
+ * POST /1.0/Retold/Stricture/Generate/MySQL
+ *
+ * Accepts a compiled stricture model and returns MySQL CREATE TABLE statements.
+ *
+ * Body: { "Model": { "Tables": { ... }, ... } }
+ * Returns: { "Files": { "Model.mysql.sql": "CREATE TABLE ..." } }
+ */
+module.exports = function(pStrictureService, pOratorServiceServer)
+{
+	pStrictureService.registerGenerateEndpoint(pOratorServiceServer, 'MySQL', require('stricture/source/Stricture-Generate-MySQL.js'));
+};

package/source/services/stricture/Stricture-Command-Generate-MySQLMigrate.js

@@ -0,0 +1,14 @@
+/**
+ * Stricture Command - Generate MySQL Migrate
+ *
+ * POST /1.0/Retold/Stricture/Generate/MySQLMigrate
+ *
+ * Accepts a compiled stricture model and returns MySQL migration stubs.
+ *
+ * Body: { "Model": { "Tables": { ... }, ... } }
+ * Returns: { "Files": { "Model-MigrateMySQL.sql": "INSERT INTO ... SELECT ..." } }
+ */
+module.exports = function(pStrictureService, pOratorServiceServer)
+{
+	pStrictureService.registerGenerateEndpoint(pOratorServiceServer, 'MySQLMigrate', require('stricture/source/Stricture-Generate-MySQL-Migrate.js'));
+};

package/source/services/stricture/Stricture-Command-Generate-Pict.js

@@ -0,0 +1,14 @@
+/**
+ * Stricture Command - Generate Pict
+ *
+ * POST /1.0/Retold/Stricture/Generate/Pict
+ *
+ * Accepts a compiled stricture model and returns PICT UI model definitions.
+ *
+ * Body: { "Model": { "Tables": { ... }, ... } }
+ * Returns: { "Files": { "Model.json": "{...}" } }
+ */
+module.exports = function(pStrictureService, pOratorServiceServer)
+{
+	pStrictureService.registerGenerateEndpoint(pOratorServiceServer, 'Pict', require('stricture/source/Stricture-Generate-Pict.js'));
+};

package/source/services/stricture/Stricture-Command-Generate-TestObjectContainers.js

@@ -0,0 +1,14 @@
+/**
+ * Stricture Command - Generate Test Object Containers
+ *
+ * POST /1.0/Retold/Stricture/Generate/TestObjectContainers
+ *
+ * Accepts a compiled stricture model and returns per-entity test fixture JSON files.
+ *
+ * Body: { "Model": { "Tables": { ... }, ... } }
+ * Returns: { "Files": { "TestObjectContainer-Book.json": "[{...}, ...]", ... } }
+ */
+module.exports = function(pStrictureService, pOratorServiceServer)
+{
+	pStrictureService.registerGenerateEndpoint(pOratorServiceServer, 'TestObjectContainers', require('stricture/source/Stricture-Generate-TestObjectContainers.js'));
+};

package/test/RetoldDataService_tests.js

@@ -181,7 +181,18 @@ suite
 								StorageProviderModule: 'meadow-connection-sqlite',
 
 								AutoInitializeDataService: true,
-								AutoStartOrator: true
+								AutoStartOrator: true,
+
+								Endpoints:
+									{
+										ConnectionManager: true,
+										ModelManagerWrite: true,
+										Stricture: true,
+										MeadowIntegration: true,
+										MeadowEndpoints: true,
+										MigrationManager: true,
+										MigrationManagerWebUI: true
+									}
 							});
 
 						_RetoldDataService.initializeService(
@@ -1349,5 +1360,154 @@ suite
 				);
 			}
 		);
+
+		suite
+		(
+			'Endpoint Allow-List Configuration',
+			function()
+			{
+				test
+				(
+					'isEndpointGroupEnabled should return false for disabled groups',
+					function()
+					{
+						// The main test service was created with all groups enabled
+						Expect(_RetoldDataService.isEndpointGroupEnabled('MeadowEndpoints')).to.equal(true);
+						Expect(_RetoldDataService.isEndpointGroupEnabled('Stricture')).to.equal(true);
+						Expect(_RetoldDataService.isEndpointGroupEnabled('ConnectionManager')).to.equal(true);
+					}
+				);
+				test
+				(
+					'isEndpointGroupEnabled should return false for unknown groups',
+					function()
+					{
+						Expect(_RetoldDataService.isEndpointGroupEnabled('NonExistentGroup')).to.equal(false);
+					}
+				);
+				test
+				(
+					'Default configuration should only enable MeadowEndpoints',
+					function(fDone)
+					{
+						let tmpFable2 = new libFable(
+							{
+								APIServerPort: 9331,
+								LogStreams: [{streamtype: 'console', level: 'fatal'}],
+								SQLite: { SQLiteFilePath: ':memory:' }
+							});
+
+						tmpFable2.serviceManager.addServiceType('MeadowSQLiteProvider', libMeadowConnectionSQLite);
+						tmpFable2.serviceManager.instantiateServiceProvider('MeadowSQLiteProvider');
+
+						tmpFable2.MeadowSQLiteProvider.connectAsync(
+							(pConnError) =>
+							{
+								if (pConnError) { return fDone(pConnError); }
+
+								tmpFable2.serviceManager.addServiceType('RetoldDataService', require('../source/Retold-Data-Service.js'));
+								let tmpService2 = tmpFable2.serviceManager.instantiateServiceProvider('RetoldDataService',
+									{
+										AutoStartOrator: false,
+										StorageProvider: 'SQLite',
+										StorageProviderModule: 'meadow-connection-sqlite',
+										FullMeadowSchemaPath: `${process.cwd()}/test/model/`,
+										FullMeadowSchemaFilename: `MeadowModel-Extended.json`
+									});
+
+								// Check the defaults
+								Expect(tmpService2.isEndpointGroupEnabled('MeadowEndpoints')).to.equal(true);
+								Expect(tmpService2.isEndpointGroupEnabled('ConnectionManager')).to.equal(false);
+								Expect(tmpService2.isEndpointGroupEnabled('ModelManagerWrite')).to.equal(false);
+								Expect(tmpService2.isEndpointGroupEnabled('Stricture')).to.equal(false);
+								Expect(tmpService2.isEndpointGroupEnabled('MeadowIntegration')).to.equal(false);
+								Expect(tmpService2.isEndpointGroupEnabled('MigrationManager')).to.equal(false);
+								Expect(tmpService2.isEndpointGroupEnabled('MigrationManagerWebUI')).to.equal(false);
+
+								fDone();
+							});
+					}
+				);
+				test
+				(
+					'Schema read routes should always be available even with restrictive config',
+					function(fDone)
+					{
+						this.timeout(10000);
+
+						let tmpFable3 = new libFable(
+							{
+								APIServerPort: 9332,
+								LogStreams: [{streamtype: 'console', level: 'fatal'}],
+								SQLite: { SQLiteFilePath: ':memory:' }
+							});
+
+						tmpFable3.serviceManager.addServiceType('MeadowSQLiteProvider', libMeadowConnectionSQLite);
+						tmpFable3.serviceManager.instantiateServiceProvider('MeadowSQLiteProvider');
+
+						tmpFable3.MeadowSQLiteProvider.connectAsync(
+							(pConnError) =>
+							{
+								if (pConnError) { return fDone(pConnError); }
+
+								let tmpDB3 = tmpFable3.MeadowSQLiteProvider.db;
+								tmpDB3.exec(`CREATE TABLE IF NOT EXISTS Book (IDBook INTEGER PRIMARY KEY AUTOINCREMENT, GUIDBook TEXT, CreateDate TEXT, CreatingIDUser INTEGER DEFAULT 0, UpdateDate TEXT, UpdatingIDUser INTEGER DEFAULT 0, Deleted INTEGER DEFAULT 0, DeleteDate TEXT, DeletingIDUser INTEGER DEFAULT 0, Title TEXT, Type TEXT, Genre TEXT, ISBN TEXT, Language TEXT, ImageURL TEXT, PublicationYear INTEGER DEFAULT 0);`);
+
+								tmpFable3.serviceManager.addServiceType('RetoldDataService', require('../source/Retold-Data-Service.js'));
+								tmpFable3.serviceManager.instantiateServiceProvider('RetoldDataService',
+									{
+										StorageProvider: 'SQLite',
+										StorageProviderModule: 'meadow-connection-sqlite',
+										FullMeadowSchemaPath: `${process.cwd()}/test/model/`,
+										FullMeadowSchemaFilename: `MeadowModel-Extended.json`,
+										AutoStartOrator: true,
+										Endpoints:
+											{
+												ConnectionManager: false,
+												ModelManagerWrite: false,
+												Stricture: false,
+												MeadowIntegration: false,
+												MeadowEndpoints: true
+											}
+									});
+
+								tmpFable3.RetoldDataService.initializeService(
+									(pInitError) =>
+									{
+										if (pInitError) { return fDone(pInitError); }
+
+										let tmpSuperTest3 = libSuperTest(`http://localhost:9332/`);
+
+										// Schema read routes should always be available
+										tmpSuperTest3
+											.get('1.0/Retold/Models')
+											.expect(200)
+											.end(
+												(pError, pResponse) =>
+												{
+													let tmpModels = JSON.parse(pResponse.text);
+													Expect(tmpModels).to.be.an('array');
+
+													// Clean up
+													if (tmpFable3.OratorServiceServer && tmpFable3.OratorServiceServer.server)
+													{
+														tmpFable3.OratorServiceServer.server.close(
+															() =>
+															{
+																try { tmpFable3.MeadowSQLiteProvider.db.close(); } catch(e) {}
+																fDone();
+															});
+													}
+													else
+													{
+														fDone();
+													}
+												});
+									});
+							});
+					}
+				);
+			}
+		);
 	}
 );