retold-data-service 1.0.0

package/.config/luxury-extras/model/json_schema_model/BookStore-PICT.json

@@ -0,0 +1 @@
+{}

package/.config/luxury-extras/model/json_schema_model/BookStore.json

@@ -0,0 +1,280 @@
+{
+    "Tables": {
+        "Book": {
+            "TableName": "Book",
+            "Domain": "Default",
+            "Columns": [
+                {
+                    "Column": "IDBook",
+                    "DataType": "ID"
+                },
+                {
+                    "Column": "GUIDBook",
+                    "DataType": "GUID"
+                },
+                {
+                    "Column": "CreateDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "CreatingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "UpdateDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "UpdatingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "Deleted",
+                    "DataType": "Boolean"
+                },
+                {
+                    "Column": "DeleteDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "DeletingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "Title",
+                    "DataType": "String",
+                    "Size": "200"
+                },
+                {
+                    "Column": "Type",
+                    "DataType": "String",
+                    "Size": "32"
+                },
+                {
+                    "Column": "Genre",
+                    "DataType": "String",
+                    "Size": "128"
+                },
+                {
+                    "Column": "ISBN",
+                    "DataType": "String",
+                    "Size": "64"
+                },
+                {
+                    "Column": "Language",
+                    "DataType": "String",
+                    "Size": "12"
+                },
+                {
+                    "Column": "ImageURL",
+                    "DataType": "String",
+                    "Size": "254"
+                },
+                {
+                    "Column": "PublicationYear",
+                    "DataType": "Numeric"
+                }
+            ],
+            "Description": ""
+        },
+        "BookAuthorJoin": {
+            "TableName": "BookAuthorJoin",
+            "Domain": "Default",
+            "Columns": [
+                {
+                    "Column": "IDBookAuthorJoin",
+                    "DataType": "ID"
+                },
+                {
+                    "Column": "GUIDBookAuthorJoin",
+                    "DataType": "GUID"
+                },
+                {
+                    "Column": "IDBook",
+                    "DataType": "Numeric",
+                    "Join": "IDBook"
+                },
+                {
+                    "Column": "IDAuthor",
+                    "DataType": "Numeric",
+                    "Join": "IDAuthor"
+                }
+            ],
+            "Description": ""
+        },
+        "Author": {
+            "TableName": "Author",
+            "Domain": "Default",
+            "Columns": [
+                {
+                    "Column": "IDAuthor",
+                    "DataType": "ID"
+                },
+                {
+                    "Column": "GUIDAuthor",
+                    "DataType": "GUID"
+                },
+                {
+                    "Column": "CreateDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "CreatingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "UpdateDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "UpdatingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "Deleted",
+                    "DataType": "Boolean"
+                },
+                {
+                    "Column": "DeleteDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "DeletingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "Name",
+                    "DataType": "String",
+                    "Size": "200"
+                }
+            ],
+            "Description": ""
+        },
+        "BookPrice": {
+            "TableName": "BookPrice",
+            "Domain": "Default",
+            "Columns": [
+                {
+                    "Column": "IDBookPrice",
+                    "DataType": "ID"
+                },
+                {
+                    "Column": "GUIDBookPrice",
+                    "DataType": "GUID"
+                },
+                {
+                    "Column": "CreateDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "CreatingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "UpdateDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "UpdatingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "Deleted",
+                    "DataType": "Boolean"
+                },
+                {
+                    "Column": "DeleteDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "DeletingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "Price",
+                    "DataType": "Decimal",
+                    "Size": "8,2"
+                },
+                {
+                    "Column": "StartDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "EndDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "Discountable",
+                    "DataType": "Boolean"
+                },
+                {
+                    "Column": "CouponCode",
+                    "DataType": "String",
+                    "Size": "16"
+                },
+                {
+                    "Column": "IDBook",
+                    "DataType": "Numeric",
+                    "Join": "IDBook"
+                }
+            ],
+            "Description": ""
+        },
+        "Review": {
+            "TableName": "Review",
+            "Domain": "Default",
+            "Columns": [
+                {
+                    "Column": "IDReviews",
+                    "DataType": "ID"
+                },
+                {
+                    "Column": "GUIDReviews",
+                    "DataType": "GUID"
+                },
+                {
+                    "Column": "CreateDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "CreatingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "UpdateDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "UpdatingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "Deleted",
+                    "DataType": "Boolean"
+                },
+                {
+                    "Column": "DeleteDate",
+                    "DataType": "DateTime"
+                },
+                {
+                    "Column": "DeletingIDUser",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "Text",
+                    "DataType": "Text"
+                },
+                {
+                    "Column": "Rating",
+                    "DataType": "Numeric"
+                },
+                {
+                    "Column": "IDBook",
+                    "DataType": "Numeric",
+                    "Join": "IDBook"
+                }
+            ],
+            "Description": ""
+        }
+    }
+}

package/.config/luxury-extras/model/json_schema_model/README.md

@@ -0,0 +1 @@
+This is where the meadow high-level JSON schema of the data model will generate.

package/.config/luxury-extras/model/mysql_create/BookStore-CreateDatabase.mysql.sql

@@ -0,0 +1,116 @@
+-- Data Model -- Generated 2022-03-29T11:36:36.684Z
+
+-- This script creates the following tables:
+-- Table ----------------------------------------- Column Count ----------------
+--   Book                                                   16
+--   BookAuthorJoin                                          4
+--   Author                                                 10
+--   BookPrice                                              15
+--   Review                                                 12
+
+
+
+--   [ Book ]
+CREATE TABLE IF NOT EXISTS
+    Book
+    (
+        IDBook INT UNSIGNED NOT NULL AUTO_INCREMENT,
+        GUIDBook CHAR(36) NOT NULL DEFAULT '00000000-0000-0000-0000-000000000000',
+        CreateDate DATETIME,
+        CreatingIDUser INT NOT NULL DEFAULT '0',
+        UpdateDate DATETIME,
+        UpdatingIDUser INT NOT NULL DEFAULT '0',
+        Deleted TINYINT NOT NULL DEFAULT '0',
+        DeleteDate DATETIME,
+        DeletingIDUser INT NOT NULL DEFAULT '0',
+        Title CHAR(200) NOT NULL DEFAULT '',
+        Type CHAR(32) NOT NULL DEFAULT '',
+        Genre CHAR(128) NOT NULL DEFAULT '',
+        ISBN CHAR(64) NOT NULL DEFAULT '',
+        Language CHAR(12) NOT NULL DEFAULT '',
+        ImageURL CHAR(254) NOT NULL DEFAULT '',
+        PublicationYear INT NOT NULL DEFAULT '0',
+
+        PRIMARY KEY (IDBook)
+    ) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
+
+
+--   [ BookAuthorJoin ]
+CREATE TABLE IF NOT EXISTS
+    BookAuthorJoin
+    (
+        IDBookAuthorJoin INT UNSIGNED NOT NULL AUTO_INCREMENT,
+        GUIDBookAuthorJoin CHAR(36) NOT NULL DEFAULT '00000000-0000-0000-0000-000000000000',
+        IDBook INT NOT NULL DEFAULT '0',
+        IDAuthor INT NOT NULL DEFAULT '0',
+
+        PRIMARY KEY (IDBookAuthorJoin)
+    ) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
+
+
+--   [ Author ]
+CREATE TABLE IF NOT EXISTS
+    Author
+    (
+        IDAuthor INT UNSIGNED NOT NULL AUTO_INCREMENT,
+        GUIDAuthor CHAR(36) NOT NULL DEFAULT '00000000-0000-0000-0000-000000000000',
+        CreateDate DATETIME,
+        CreatingIDUser INT NOT NULL DEFAULT '0',
+        UpdateDate DATETIME,
+        UpdatingIDUser INT NOT NULL DEFAULT '0',
+        Deleted TINYINT NOT NULL DEFAULT '0',
+        DeleteDate DATETIME,
+        DeletingIDUser INT NOT NULL DEFAULT '0',
+        Name CHAR(200) NOT NULL DEFAULT '',
+
+        PRIMARY KEY (IDAuthor)
+    ) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
+
+
+--   [ BookPrice ]
+CREATE TABLE IF NOT EXISTS
+    BookPrice
+    (
+        IDBookPrice INT UNSIGNED NOT NULL AUTO_INCREMENT,
+        GUIDBookPrice CHAR(36) NOT NULL DEFAULT '00000000-0000-0000-0000-000000000000',
+        CreateDate DATETIME,
+        CreatingIDUser INT NOT NULL DEFAULT '0',
+        UpdateDate DATETIME,
+        UpdatingIDUser INT NOT NULL DEFAULT '0',
+        Deleted TINYINT NOT NULL DEFAULT '0',
+        DeleteDate DATETIME,
+        DeletingIDUser INT NOT NULL DEFAULT '0',
+        Price DECIMAL(8,2),
+        StartDate DATETIME,
+        EndDate DATETIME,
+        Discountable TINYINT NOT NULL DEFAULT '0',
+        CouponCode CHAR(16) NOT NULL DEFAULT '',
+        IDBook INT NOT NULL DEFAULT '0',
+
+        PRIMARY KEY (IDBookPrice)
+    ) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
+
+
+--   [ Review ]
+CREATE TABLE IF NOT EXISTS
+    Review
+    (
+        IDReviews INT UNSIGNED NOT NULL AUTO_INCREMENT,
+        GUIDReviews CHAR(36) NOT NULL DEFAULT '00000000-0000-0000-0000-000000000000',
+        CreateDate DATETIME,
+        CreatingIDUser INT NOT NULL DEFAULT '0',
+        UpdateDate DATETIME,
+        UpdatingIDUser INT NOT NULL DEFAULT '0',
+        Deleted TINYINT NOT NULL DEFAULT '0',
+        DeleteDate DATETIME,
+        DeletingIDUser INT NOT NULL DEFAULT '0',
+        Text TEXT,
+        Rating INT NOT NULL DEFAULT '0',
+        IDBook INT NOT NULL DEFAULT '0',
+
+        PRIMARY KEY (IDReviews)
+    ) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

package/.config/luxury-extras/model/mysql_create/README.md

@@ -0,0 +1 @@
+This is where the MYSQL Create statement for the data model will generate.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Steven Velozo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+# Retold Data Service
+
+Provide a consistent back or mid-tier data service.
+
+## Basic Usage
+
+This library can run in any of three types of configurations:
+
+* Configuration Driven
+* Managed via Backplane Endpoints
+* Hybrid (configuration plus endpoint)
+
+## Configuration-Driven Mode
+
+The service looks for a `Retold` stanza in the configuration.  For instance:
+
+```
+{
+    ...
+    "Retold": {
+        "MeadowModel": "./meadow-schema-extended.json"
+    },
+    ...
+}
+```
+
+The three auto-configured parameters are:
+
+* `MeadowModel`
+* `MeadowEntitySchema`
+* `StrictureDDL`
+
+The service tries to do the right thing with strings versus arrays -- you can pass an array of models or a single.  Likewise, you can pass an array of schemas or a single.  It also supports grabbing all files of a single folder with the `/*` suffix, and recursive with the `/**` suffix.  When used in this fashion, only `.json` files are loaded from the folder(s).
+
+## Supplied Backplane Endpoints
+
+### Load a Meadow Model
+
+```
+POST /BackPlane/${VERSION}/Load/MeadowModel
+```
+
+This endpoint accepts a JSON blob of an entire Meadow model.  It loads the entire model as a set of endpoints, and connects each endpoint to the default provider.
+
+### Load a Meadow Entity Schema
+
+```
+POST /BackPlane/${VERSION}/Load/MeadowSchema
+```
+
+This endpoint accepts a JSON blob of an entire Meadow model.  It loads the entire model as a set of endpoints, and connects each endpoint to the default provider.
+
+### Load a DDL and Compile it
+```
+POST /BackPlane/${VERSION}/Load/StrictureDDL
+```
+
+This endpoint loads a Stricture DDL, compiles it into the composite Entity schemas and loads them as endpoints.
+
+
+### Access Primary Service Model and Composite Models
+```
+GET /BackPlane/${VERSION}/Model/Primary/
+```
+
+GET /BackPlane/${VERSION}/Model/Composite/
+
+### Merge in Settings (to push default configurations for providers)
+```
+POST /BackPlane/${VERSION}/Settings
+```
+
+### Set the Default Provider
+```
+GET /BackPlane/${VERSION}/SetProvider/:ProviderName
+```
+
+### Set an Entity-Specific Provider
+```
+GET /BackPlane/${VERSION}/SetProvider/:ProviderName/:Entity
+```
+
+
+
+
+

package/debug/Harness-Configuration.json

@@ -0,0 +1,51 @@
+{
+	"Product": "RetoldDataService-Harness",
+	"ProductVersion": "1.0.0",
+
+	"UUID":
+		{
+			"DataCenter": 0,
+			"Worker": 0
+		},
+	"LogStreams":
+		[
+			{
+				"level": "trace",
+				"streamtype": "prettystream"
+			}
+		],
+
+	"APIServerPort": 8088,
+
+	"Retold":
+		{
+			"AutoLoadModel": true,
+			"AutoConnectProvider": true,
+			"AutoMapBackplaneEndpoints": true,
+			"AutoMapEntityEndpoints": true,
+			"AutoStartAPIServer": true,
+
+			"AllowDatabaseCreate": false,
+			"AllowTableCreate": false,
+			"AllowTableUpdate": false,
+
+			"ServeDebugEnvironment": true,
+
+			"DefaultMeadowDataProvider": "MySQL",
+
+			"MeadowModel":              "/home/coder/retold-dev/library/debug/model/Model.json",
+			"MeadowEntitySchemaPrefix": "/home/coder/retold-dev/library/debug/model/meadow/Model-MeadowSchema-",
+
+			"StrictureDDL": false
+		},
+
+	"MySQL":
+		{
+			"Server": "127.0.0.1",
+			"Port": 3306,
+			"User": "root",
+			"Password": "123456789",
+			"Database": "bookstore",
+			"ConnectionPoolLimit": 20
+		}
+}

package/debug/Harness.js

@@ -0,0 +1,3 @@
+const libRetoldDataService = require('../source/Retold-Data-Service.js');
+
+const _DataService = new libRetoldDataService(require('./Harness-Configuration.json'));

package/debug/model/Build-Database.sh

@@ -0,0 +1,22 @@
+#! /bin/bash
+echo "Example - Database Build Script"
+echo "Contact: Steven Velozo <steven@velozo.com>"
+echo ""
+echo "---"
+echo ""
+
+echo "--> Generating JSON model from DDL (with the BookStore prefix)"
+npx stricture -i ./ddl/Model.ddl -c Compile -f ./ -o Model
+
+echo "--> Generating MySQL Create Statements"
+npx stricture -i ./Model-Extended.json -c MySQL -f ./mysql/ -o "Model-CreateDatabase"
+
+echo "--> Generating Meadow Schemas"
+npx stricture -i ./Model-Extended.json -c Meadow -f ./meadow/ -o "Model-MeadowSchema-"
+
+echo "--> Generating Documentation"
+npx stricture -i ./Model-Extended.json -c Documentation -g -f ./generated_documentation/
+npx stricture -i ./Model-Extended.json -c Relationships -g -f ./generated_documentation/diagrams/
+npx stricture -i ./Model-Extended.json -c RelationshipsFull -g -f ./generated_documentation/diagrams/full/
+
+echo "--> Database Code generation and compilation complete!"