Cleanups.

Author: evoluteur

README.md

@@ -11,8 +11,8 @@ For a matching model-driven Web UI, use [Evolutility-UI-React](http://github.com
 1. [Installation](#Installation)
 2. [Setup](#Setup)
 3. [Configuration](#Configuration)
-4. [Models](#Models)
-5. [API](#API)
+4. [Models](#Models): [Object](#Object) - [Field](#Field) - [Collection](#Collection)
+5. [API](#API): [Get](#API_Get) - [Update](#API_Update) - [More](#API_Extras)
 6. [License](#License)
 
 
@@ -59,7 +59,7 @@ npm start
 
 **Note**: The database creation and population scripts are logged in the files "evol-db-schema-{datetime}.sql" and  "evol-db-data-{datetime}.sql".
 
-In a web browser, go to the url [http://localhost:2000/api/v1/evolutility/todo](http://localhost:2000/api/v1/evolutility/todo).
+In a web browser, go to [http://localhost:2000/api/v1/](http://localhost:2000/api/v1/) for REST or [http://localhost:2000/graphql](http://localhost:2000/graphql) for GraphQL.
 
 
 <a name="Configuration"></a>
@@ -70,7 +70,7 @@ Configuration options are set in the file [config.js](https://github.com/evolute
 
 | Option        | Description                             |
 |---------------|-----------------------------------------|
-| apiPath       | Path for REST API (i.e.: "/api/v1/evolutility/"). |
+| apiPath       | Path for REST API (i.e.: "/api/v1/"). |
 | apiPort       | Port for REST API (i.e.: 2000). |
 | connectionString | DB connection string (i.e.: "postgres://evol:love@localhost:5432/evol"). |
 | schema        | DB schema name (i.e.: "evolutility").|
@@ -91,7 +91,7 @@ Configuration options are set in the file [config.js](https://github.com/evolute
 To be accessible by the REST API, each database table must be described in a model.
 Models contain the name of the driving table and the list of fields/columns present in the API.
 
-
+<a name="Object"></a>
 ### Object
 
 | Property     | Description                             |
@@ -103,7 +103,7 @@ Models contain the name of the driving table and the list of fields/columns pres
 | titleField   | Field id for the column value used as record title. |
 | searchFields | Array of field ids for fields used to perform searches.  |  
 
-
+<a name="Field"></a>
 ### Field
 
 | Property     | Description                           |
@@ -125,7 +125,7 @@ Models contain the name of the driving table and the list of fields/columns pres
 | deleteTrigger | Deleting records in the lovTable will trigger a cascade delete (this property is only used while creating the database). |
 
 
-
+<a name="Collection"></a>
 ### Collection
 
 Multiple Master-Details can be specified with collections. 
@@ -142,6 +142,7 @@ Multiple Master-Details can be specified with collections.
 Example of collection in [Wine cellar](https://github.com/evoluteur/evolutility-server-node/blob/master/models/pim/winecellar.js).
 
 
+<a name="SampleModel"></a>
 ### Sample model
 
 Below is the model for a To-Do app.
@@ -209,9 +210,9 @@ Evolutility-Server-Node provides a generic RESTful API for CRUD (Create, Read, U
 The API is inspired from [PostgREST](http://postgrest.com).
 
 When running Evolutility-Server-Node locally, the url for the "todo" app is 
-[http://localhost:2000/api/v1/evolutility/todo](http://localhost:2000/api/v1/evolutility/todo).
-
+[http://localhost:2000/api/v1/todo](http://localhost:2000/api/v1/todo).
 
+<a name="API_Get"></a>
 ### Requesting Information
 
 #### Get One
@@ -313,6 +314,7 @@ GET /todo?format=csv
 ```
 Notes: In the returned data every object has an extra property "\_full_count" which indicate the total number of records in the query (before limit).
 
+<a name="API_Update"></a>
 ### Updating Data
 
 #### Record creation
@@ -358,6 +360,7 @@ DELETE /<model.id>/<id>
 DELETE /todo/5
 ```
 
+<a name="API_Extras"></a>
 ### Extras endpoints
 
 In addition to CRUD, Evolutility-Server-Node provides a few endpoints for Charts, Lists of values, file upload, and API discovery.

config.js

@@ -12,6 +12,7 @@ module.exports = {
 	connectionString: process.env.DATABASE_URL || 'postgres://evol:love@localhost:5432/Evolutility', 
 	schema: 'evolutility',
 
+	// OPTIONS
 	// Pagination and maximum number of rows
 	pageSize: 50,
 	lovSize: 100,
@@ -22,7 +23,6 @@ module.exports = {
 	wTimestamp: true,
 	// - "WhoIs" columns u_uid and c_uid w/ userid of creator and last modifier
 	wWhoIs: false,
-
 	// - Comments & Ratings (community feature) 
 	wComments: false,
 	wRating: false,

js/graphql-schema.js

@@ -84,6 +84,23 @@ const model2gqlObjectType = m => {
         fields['c_date'] = gqlField({type: ft.datetime})
         fields['u_date'] =  gqlField({type: ft.datetime})
     }
+    /*
+    // - "who-is" columns to track user who created and last modified the record.
+    if(config.wWhoIs){
+        fields['c_uid'] =  gqlField({type: 'date'})
+        fields['u_uid'] = gqlField({type: 'date'})
+    }
+    */
+    // - tracking number of comments.
+    if(config.wComments){
+        fields['nb_comments'] =  gqlField({type: ft.int})
+    }
+    // - tracking ratings.
+    if(config.wRating){
+        fields['nb_ratings'] =  gqlField({type: ft.int})
+        fields['avg_ratings'] =  gqlField({type: ft.dec})
+    } 
+    
     return new GraphQLObjectType({
         name: m.id,
         fields: fields,
@@ -173,7 +190,7 @@ const makeGQLschema = () => {
 const RootQuery = new GraphQLObjectType({
     name: 'RootQueryType',
     fields: makeGQLschema(),
-    description: 'Evolutility'
+    description: 'Evolutility active models.'
 })
 
 module.exports = new GraphQLSchema({

js/routes.js

@@ -45,21 +45,21 @@ if(config.schemaQueries){
 router.get(apiPath+':entity/stats', stats.numbers);
 
 // ======  CRUD ====================================
-// -  GET MANY ------------------------------------
+// -  GET MANY -
 router.get(apiPath+':entity', crud.getMany);
-// -  GET ONE   ------------------------------------
+// -  GET ONE   -
 router.get(apiPath+':entity/:id', crud.getOne);
-// -  INSERT ONE ------------------------------------
+// -  INSERT ONE -
 router.post(apiPath+':entity', crud.insertOne);
-// -  UPDATE ONE  ------------------------------------
+// -  UPDATE ONE  -
 router.patch(apiPath+':entity/:id', crud.updateOne);
 router.put(apiPath+':entity/:id', crud.updateOne);
 router.post(apiPath+':entity/upload/:id', upload.uploadOne);
-// -  DELETE ONE ------------------------------------
+// -  DELETE ONE -
 router.delete(apiPath+':entity/:id', crud.deleteOne);
-// -  LOV -----------------------------------------
+// -  LOV -
 router.get(apiPath+':entity/lov/:field', crud.lovOne);
-// -  SUB-COLLECTIONS  ------------------------------------
+// -  SUB-COLLECTIONS  -
 router.get(apiPath+':entity/collec/:collec', crud.getCollec);
 
 // ======  GET CHARTS ====================================

js/setup/database.js

@@ -187,7 +187,7 @@ function sqlSchemaWithData(){
     }
 }
 
-const sqlComment = (target, targetName, targetId) => 'COMMENT ON '+target+' '+targetName+' IS \''+targetId.replace(/'/g,'')+'\';\n'
+const sqlComment = (target, targetName, targetId) => 'COMMENT ON '+target+' '+targetName+' IS \''+(targetId?targetId.replace(/'/g,''):'')+'\';\n'
 
 const sqlIndex = (index, table, column) => 'CREATE INDEX idx_'+index+' ON '+table+' USING btree ('+column+');\n';
 /*
@@ -336,11 +336,11 @@ function createSchema(runSQL = true, logFile = true){
         dbConfig.idleTimeoutMillis = 30000; // max client idle time before being closed
         const pool = new pg.Pool(dbConfig);
 
+        if(logFile) {
+            logToFile(sql, false)
+        }
         pool.connect(function(err, client, done) {
             // - Create schema and tables
-            if(logFile) {
-                logToFile(sql, false)
-            }
             client.query(sql, function(err, data) {
                 if(err){ 
                     done();

js/utils/errors.js

@@ -6,6 +6,7 @@ function badRequest(res, msg, errorCode = 400) {
 	logger.logError(msg)
     res.statusMessage = errorMsg
     res.status(errorCode).end();
+    return res
 }
 
 module.exports = {

models/all_models.js

@@ -1,3 +1,12 @@
+/*
+  ___         _      _   _ _ _ _         
+ | __|_ _____| |_  _| |_(_) (_) |_ _  _  
+ | _|\ V / _ \ | || |  _| | | |  _| || | 
+ |___|\_/\___/_|\_,_|\__|_|_|_|\__|\_, | 
+                                   |__/  
+https://github.com/evoluteur/evolutility-models
+*/
+
 module.exports = {
   todo: require('./pim/todo'),
   contact: require('./pim/contact'),

models/data/all_data.js

@@ -1,3 +1,11 @@
+/*
+  ___         _      _   _ _ _ _         
+ | __|_ _____| |_  _| |_(_) (_) |_ _  _  
+ | _|\ V / _ \ | || |  _| | | |  _| || | 
+ |___|\_/\___/_|\_,_|\__|_|_|_|\__|\_, | 
+                                   |__/  
+https://github.com/evoluteur/evolutility-models
+*/
 
 module.exports = {
 	todo: require('./pim/todo-data'),

package.json

@@ -11,21 +11,22 @@
   },
   "bugs": "https://github.com/evoluteur/evolutility-server-node/issues",
   "scripts": {
-    "start": "supervisor ./bin/www"
+    "start": "supervisor ./bin/www",
+    "makedb": "node js/setup/database.js"
   },
   "dependencies": {
     "chalk": "~2.4.2",
     "body-parser": "~1.18.3",
     "csv-express": "~1.2.2",
     "debug": "~4.1.1",
-    "express": "~4.16.4",
-    "express-graphql": "~0.7.1",
+    "express": "~4.17.1",
+    "express-graphql": "~0.8.0",
+    "graphql": "~14.4.2",
     "formidable": "~1.2.1",
-    "graphql": "~14.1.1",
-    "helmet": "~3.15.0",
-    "pg": "^7.8.0",
-    "pg-connection-string": "~2.0.0",
-    "pg-promise": "^8.6.4",
+    "helmet": "~3.18.0",
+    "pg": "^7.11.0",
+    "pg-connection-string": "~2.1.0",
+    "pg-promise": "^8.7.3",
     "shortid": "~2.2.14",
     "supervisor": "~0.12.0",
     "underscore": "~1.9.1"
@@ -37,6 +38,7 @@
     "MDA",
     "platform",
     "REST",
+    "GraphQL",
     "metadata",
     "database",
     "nodejs",