retold-data-service 2.0.9 → 2.0.11

package/docs/storage-providers.md

@@ -0,0 +1,109 @@
+# Storage Providers
+
+Retold Data Service supports any Meadow-compatible storage provider.  The provider is configured through the `StorageProvider` and `StorageProviderModule` options.
+
+## Available Providers
+
+| Provider | Module | Best For |
+|----------|--------|----------|
+| MySQL | `meadow-connection-mysql` | Production web applications |
+| SQLite | `meadow-connection-sqlite` | Embedded apps, testing, single-server deployments |
+| MSSQL | `meadow-connection-mssql` | Enterprise SQL Server environments |
+| ALASQL | Built into Meadow | In-memory / browser-side usage |
+
+## MySQL Setup
+
+MySQL is the default provider.
+
+```javascript
+const settings = {
+    APIServerPort: 8086,
+    MySQL: {
+        Server: '127.0.0.1',
+        Port: 3306,
+        User: 'root',
+        Password: 'secret',
+        Database: 'mydb',
+        ConnectionPoolLimit: 20
+    },
+    MeadowConnectionMySQLAutoConnect: true
+};
+
+const _Fable = new libFable(settings);
+
+_Fable.serviceManager.instantiateServiceProvider('RetoldDataService', {
+    StorageProvider: 'MySQL',
+    StorageProviderModule: 'meadow-connection-mysql',
+    FullMeadowSchemaPath: `${__dirname}/model/`,
+    FullMeadowSchemaFilename: 'MeadowModel-Extended.json'
+});
+```
+
+## SQLite Setup
+
+SQLite requires pre-registering the connection provider before creating the data service:
+
+```javascript
+const libMeadowConnectionSQLite = require('meadow-connection-sqlite');
+
+const settings = {
+    APIServerPort: 8086,
+    SQLite: { SQLiteFilePath: './data/app.db' }
+};
+
+const _Fable = new libFable(settings);
+
+// Register and connect SQLite before creating the data service
+_Fable.serviceManager.addServiceType('MeadowSQLiteProvider', libMeadowConnectionSQLite);
+_Fable.serviceManager.instantiateServiceProvider('MeadowSQLiteProvider');
+
+_Fable.MeadowSQLiteProvider.connectAsync(
+    (pError) =>
+    {
+        _Fable.serviceManager.instantiateServiceProvider('RetoldDataService', {
+            StorageProvider: 'SQLite',
+            StorageProviderModule: 'meadow-connection-sqlite',
+            FullMeadowSchemaPath: `${__dirname}/model/`,
+            FullMeadowSchemaFilename: 'MeadowModel-Extended.json'
+        });
+
+        _Fable.RetoldDataService.initializeService(callback);
+    });
+```
+
+For in-memory testing, use `':memory:'` as the SQLite file path:
+
+```javascript
+SQLite: { SQLiteFilePath: ':memory:' }
+```
+
+## MSSQL Setup
+
+```javascript
+const settings = {
+    APIServerPort: 8086,
+    MSSQL: {
+        Server: '127.0.0.1',
+        Port: 1433,
+        User: 'sa',
+        Password: 'YourPassword123',
+        Database: 'mydb'
+    }
+};
+
+_Fable.serviceManager.instantiateServiceProvider('RetoldDataService', {
+    StorageProvider: 'MSSQL',
+    StorageProviderModule: 'meadow-connection-mssql',
+    FullMeadowSchemaPath: `${__dirname}/model/`,
+    FullMeadowSchemaFilename: 'MeadowModel-Extended.json'
+});
+```
+
+## Changing the Provider at Runtime
+
+After initialization, each entity's provider can be changed individually:
+
+```javascript
+_Fable.DAL.Book.setProvider('MySQL');
+_Fable.DAL.Author.setProvider('SQLite');
+```

package/package.json

@@ -1,12 +1,12 @@
 {
     "name": "retold-data-service",
-    "version": "2.0.9",
+    "version": "2.0.11",
     "description": "Serve up a whole model!",
     "main": "source/Retold-Data-Service.js",
     "scripts": {
         "start": "node source/Retold-Data-Service.js",
-        "coverage": "./node_modules/.bin/nyc --reporter=lcov --reporter=text-lcov ./node_modules/mocha/bin/_mocha -- -u tdd -R spec",
-        "test": "./node_modules/.bin/mocha -u tdd -R spec",
+        "coverage": "npx nyc --reporter=lcov --reporter=text-lcov npx mocha -- -u tdd -R spec",
+        "test": "npx mocha -u tdd -R spec",
         "build": "npx quack build",
         "build-test-model": "cd test && npx stricture -i model/ddl/BookStore.ddl",
         "docker-dev-build": "docker build ./ -f Dockerfile_LUXURYCode -t retold-data-service-image:local",
@@ -51,15 +51,19 @@
     },
     "homepage": "https://github.com/stevenvelozo/retold-data-service",
     "devDependencies": {
+        "chai": "^6.2.2",
+        "meadow-connection-sqlite": "^1.0.11",
+        "mocha": "^11.7.5",
         "quackage": "^1.0.41",
-        "stricture": "^1.0.37"
+        "stricture": "^1.0.37",
+        "supertest": "^7.2.2"
     },
     "dependencies": {
         "fable": "^3.1.11",
         "fable-serviceproviderbase": "^3.0.15",
-        "meadow": "^2.0.15",
+        "meadow": "^2.0.21",
         "meadow-connection-mysql": "^1.0.4",
-        "meadow-endpoints": "^4.0.5",
+        "meadow-endpoints": "^4.0.7",
         "orator": "^5.0.1",
         "orator-http-proxy": "^1.0.1",
         "orator-serviceserver-restify": "^2.0.4",

package/source/Retold-Data-Service.js

@@ -118,11 +118,11 @@ class RetoldDataService extends libFableServiceProviderBase
 				//let tmpDALPackageFile = `${this.options.DALMeadowSchemaPath}${this.options.DALMeadowSchemaPrefix}${tmpDALEntityName}${this.options.DALMeadowSchemaPostfix}.json`
 				//this.fable.log.info(`Initializing the ${tmpDALEntityName} DAL from [${tmpDALPackageFile}]...`);
 				this._DAL[tmpDALEntityName] = this._Meadow.loadFromPackageObject(tmpDALMeadowSchema);
-				// 5. Tell this DAL object to use MySQL
-				this.fable.log.info(`...defaulting the ${tmpDALEntityName} DAL to use MySQL`);
-				this._DAL[tmpDALEntityName].setProvider('MySQL');
+				// 5. Tell this DAL object to use the configured storage provider
+				this.fable.log.info(`...defaulting the ${tmpDALEntityName} DAL to use ${this.options.StorageProvider}`);
+				this._DAL[tmpDALEntityName].setProvider(this.options.StorageProvider);
 				// 6. Create a Meadow Endpoints class for this DAL
-				this.fable.log.info(`...initializing the ${tmpDALEntityName} Meadow Endpoints to use MySQL`);
+				this.fable.log.info(`...initializing the ${tmpDALEntityName} Meadow Endpoints`);
 				this._MeadowEndpoints[tmpDALEntityName] = libMeadowEndpoints.new(this._DAL[tmpDALEntityName]);
 				// 8. Expose the meadow endpoints on Orator
 				this.fable.log.info(`...mapping the ${tmpDALEntityName} Meadow Endpoints to Orator`);