retold-data-service 2.0.8 → 2.0.10

package/docs/schema-definition.md

@@ -0,0 +1,128 @@
+# Schema Definition
+
+Retold Data Service loads a compiled Stricture schema model to create its entities and endpoints.
+
+## The Stricture DDL
+
+Schemas are defined using Stricture's DDL syntax, then compiled into a JSON model that Retold Data Service understands.
+
+### DDL Example
+
+```
+!Book
+@IDBook
+%GUIDBook
+&CreateDate
+#CreatingIDUser
+&UpdateDate
+#UpdatingIDUser
+^Deleted
+&DeleteDate
+#DeletingIDUser
+$Title 200
+$Type 32
+$Genre 128
+$ISBN 64
+$Language 12
+#PublicationYear
+
+!Author
+@IDAuthor
+%GUIDAuthor
+&CreateDate
+#CreatingIDUser
+&UpdateDate
+#UpdatingIDUser
+^Deleted
+&DeleteDate
+#DeletingIDUser
+$Name 200
+```
+
+### DDL Symbols
+
+| Symbol | Meaning | Meadow Type |
+|--------|---------|-------------|
+| `!` | Table/entity name | — |
+| `@` | Auto-increment ID | `AutoIdentity` |
+| `%` | Auto GUID | `AutoGUID` |
+| `&` | DateTime column | `CreateDate`, `UpdateDate`, `DeleteDate`, or `DateTime` |
+| `#` | Numeric column | `Integer`, `CreateIDUser`, `UpdateIDUser`, `DeleteIDUser` |
+| `$` | String column (with size) | `String` |
+| `^` | Boolean column | `Deleted` or `Boolean` |
+| `.` | Decimal column (with precision) | `Decimal` |
+| `*` | Text column | `String` (large) |
+
+## Compiling the Model
+
+Use Stricture to compile the DDL into JSON:
+
+```bash
+npx stricture -i model/ddl/BookStore.ddl
+```
+
+This produces a `MeadowModel-Extended.json` file containing the full model with:
+- Column definitions per table
+- Meadow schema per table (with `AutoIdentity`, `AutoGUID`, `CreateDate`, etc.)
+- JSON Schema per table
+- Default objects per table
+- Authorization rules per table
+
+## Model JSON Structure
+
+```json
+{
+    "Tables": {
+        "Book": {
+            "TableName": "Book",
+            "Columns": [...],
+            "MeadowSchema": {
+                "Scope": "Book",
+                "DefaultIdentifier": "IDBook",
+                "Schema": [
+                    {"Column": "IDBook", "Type": "AutoIdentity"},
+                    {"Column": "GUIDBook", "Type": "AutoGUID"},
+                    {"Column": "Title", "Type": "String", "Size": "200"},
+                    ...
+                ],
+                "DefaultObject": {
+                    "IDBook": 0,
+                    "Title": "",
+                    ...
+                },
+                "Authorization": { ... }
+            }
+        },
+        "Author": { ... }
+    }
+}
+```
+
+## Build Script
+
+The test model includes a build script for compiling the DDL:
+
+```bash
+npm run build-test-model
+```
+
+This runs `cd test && npx stricture -i model/ddl/BookStore.ddl` to regenerate the compiled model from the DDL.
+
+## Schema Types Reference
+
+| Type | Description | Auto-Managed |
+|------|-------------|-------------|
+| `AutoIdentity` | Auto-increment primary key | On Create (NULL/omit) |
+| `AutoGUID` | Unique identifier | On Create (UUID generated) |
+| `CreateDate` | Creation timestamp | On Create |
+| `CreateIDUser` | Creator user ID | On Create |
+| `UpdateDate` | Last update timestamp | On Create and Update |
+| `UpdateIDUser` | Last updater user ID | On Create and Update |
+| `Deleted` | Soft-delete flag | On Delete (set to 1) |
+| `DeleteDate` | Deletion timestamp | On Delete |
+| `DeleteIDUser` | Deleter user ID | On Delete |
+| `String` | Text data | — |
+| `Integer` | Numeric data | — |
+| `Decimal` | Decimal data | — |
+| `Boolean` | Boolean data | — |
+| `DateTime` | Date/time data | — |

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.8",
+    "version": "2.0.10",
     "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": "file:../meadow-connection-sqlite",
+        "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": "file:../meadow",
         "meadow-connection-mysql": "^1.0.4",
-        "meadow-endpoints": "^4.0.5",
+        "meadow-endpoints": "file:../meadow-endpoints",
         "orator": "^5.0.1",
         "orator-http-proxy": "^1.0.1",
         "orator-serviceserver-restify": "^2.0.4",

package/source/Retold-Data-Service.js

@@ -110,19 +110,28 @@ class RetoldDataService extends libFableServiceProviderBase
 		{
 			// 4. Create the DAL for each entry (e.g. it would be at _DAL.Movie for the Movie entity)
 			let tmpDALEntityName = this.entityList[i];
-			let tmpDALPackageObject = this.fullModel.Tables[tmpDALEntityName];
-			// We no longer need to load it from a package file; it's all in the full model
-			this.fable.log.info(`Initializing the ${tmpDALEntityName} DAL...`);
-			this._DAL[tmpDALEntityName] = this._Meadow.loadFromPackageObject(tmpDALPackageObject.MeadowSchema);
-			// 5. Tell this DAL object to use the specified 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 ${this.options.StorageProvider}`);
-			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`);
-			this._MeadowEndpoints[tmpDALEntityName].connectRoutes(this.fable.OratorServiceServer);
+			try
+			{
+				let tmpDALSchema = this.fullModel.Tables[tmpDALEntityName];
+				let tmpDALMeadowSchema = tmpDALSchema.MeadowSchema;
+
+				//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 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`);
+				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`);
+				this._MeadowEndpoints[tmpDALEntityName].connectRoutes(this.fable.OratorServiceServer);				
+			}
+			catch (pError)
+			{
+				this.fable.log.error(`Error initializing DAL and Endpoints for entity [${tmpDALEntityName}]: ${pError}`);
+			}
 		}
 
 		return fCallback();