nails-boilerplate 0.14.3 → 1.0.0

package/bin/lib/init.js

@@ -1,8 +1,12 @@
 // Install script which adds commands for running nails
 // to the path
-var fs = require('fs');
-var wrench = require('wrench');
-var exec = require('child_process').exec;
+import path from 'node:path';
+import fs from 'node:fs';
+// TODO: wrench is deprecated. check out node-fs-extra
+import wrench from 'wrench';
+// var wrench = require('wrench');
+import {exec} from 'child_process';
+// var exec = require('child_process').exec;
 var args = process.argv.slice(2);
 
 var appName = args[0];
@@ -40,35 +44,39 @@ function isNailsApp( originalDir, directory ) {
 }
 
 function createApp( name ) {
-    var templateRoot =  __dirname + "/../../templates";
+    var templateRoot =  path.resolve(import.meta.dirname, "../../templates");
     if (!fs.existsSync(name)) fs.mkdirSync(name);
-    fs.open(name + '/NAILS','w', 0666, function(err, fd) {
+    fs.open(name + '/NAILS','w', 0o666, function(err, fd) {
         if (err) throw err;
         fs.writeFileSync(name + '/NAILS', '/* This marks the root of the NAILS app */');
         fs.closeSync(fd);
 
-        wrench.copyDirSyncRecursive(templateRoot + '/app', name + '/app');
-        wrench.copyDirSyncRecursive(templateRoot + '/public', name + '/public');
-        wrench.copyDirSyncRecursive(templateRoot + '/config', name + '/config');
+        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './server'), name + '/server');
+        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './client'), name + '/client');
+        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './config'), name + '/config');
+        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './common'), name + '/common');
+        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './spec'), name + '/spec');
+        wrench.copyDirSyncRecursive(path.resolve(templateRoot, './bin'), name + '/bin');
 
         checkWrites();
     });
 
     //fs.copyFileSync(templateRoot + '/.babelrc', name + '/.babelrc');
+    fs.copyFileSync(path.resolve(templateRoot, './vite.config.ts'), name + '/vite.config.ts');
 
-    fs.open(name + '/server.js','w', 0666, function(err, fd) {
-        if (err) throw err;
-        fs.readFile(templateRoot + '/server.js', 'utf8', function(err, data) {
-            if (err) throw err;
-            fs.writeFileSync( name + '/server.js', data );
-            fs.closeSync(fd);
-            checkWrites();
-        });
-    });
+    // fs.open(name + 'bin/server.js','w', 0o666, function(err, fd) {
+    //     if (err) throw err;
+    //     fs.readFile(path.resolve(templateRoot,'./bin/server.js'), 'utf8', function(err, data) {
+    //         if (err) throw err;
+    //         fs.writeFileSync( name + '/server.js', data );
+    //         fs.closeSync(fd);
+    //         checkWrites();
+    //     });
+    // });
 
     //TODO: use toJSON to dynamically create package.json
     //TODO: install dependencies after writing package.json
-    fs.open(name + '/package.json','w', 0666, function(err, fd) {
+    fs.open(name + '/package.json','w', 0o666, function(err, fd) {
         if (err) throw err;
         fs.readFile(templateRoot + '/package.json', 'utf8', function(err, data) {
             if (err) throw err;
@@ -82,7 +90,7 @@ function createApp( name ) {
 var numWrites = 0;
 function checkWrites() {
     numWrites++;
-    if (numWrites == 3) {
+    if (numWrites == 2) {
         console.log("Initialized new Nails Application successfully");
         console.log("installing nails locally");
         // change into app directory

package/bin/lib/nails.js

@@ -1,13 +1,14 @@
 #!/usr/bin/env node
 
 // The entry point for the nails executable
-var exec = require('child_process').exec;
+import { exec } from 'child_process';
+// var exec = require('child_process').exec;
 console.log('nailsargs are: ', process.argv);
 var args = process.argv.splice(2);
 
 // TODO: print version and help info if called with no arguments
 
-var command = 'node ' + __dirname + '/' + args[0] + '.js';
+var command = 'node ' + import.meta.dirname + '/' + args[0] + '.js';
 
 for (var i = 1; i < args.length; i++) {
     command = command + " " + args[i];

package/index.js

@@ -1,3 +1,4 @@
 // Sets the Nails global object
-module.exports =  require('./lib/nails.js');
+import nails from './lib/nails.js';
+export default nails;
 // set up Nails here

package/lib/application.js

@@ -1,15 +1,22 @@
-const bodyParser = require('body-parser');
+// const bodyParser = require('body-parser');
+import pkg from 'body-parser';
+const {urlencoded, json} = pkg;
+import express from 'express';
+import expressWs from 'express-ws';
 
 /**
  * Singleton express application.
  */
-var express = require('express');
+// var express = require('express');
 var app = express();
+// TODO: this has to be done before routes in order to work. Can consider allowing the config to turn this off
+// expressWs(app);
 // Parse application/x-www-form-urlencoded
-app.use(bodyParser.urlencoded({ extended: false }));
+app.use(urlencoded({ limit: '2mb', extended: false }));
 // Parse application/json
-app.use(bodyParser.json());
-module.exports = app;
+app.use(json({limit: '2mb'}));
 
 app.Router = express.Router;
 app.static = express.static;
+
+export default app;

package/lib/collection.js

@@ -2,7 +2,5 @@
  * The collection is an object descending from the array class.
  * It comes with methods for persising groups of models to the database.
  */
-module.exports = Collection;
-
-function Collection() {
+export default function Collection() {
 }

package/lib/controller.js

@@ -1,6 +1,9 @@
-const fs = require('fs');
-const events = require('events');
-const application = require('./application');
+// const fs = require('fs');
+import fs from 'node:fs';
+import events from 'node:events';
+// const events = require('events');
+import application from './application.js';
+// const application = require('./application');
 
 var router;
 var controller_proto;
@@ -144,4 +147,4 @@ error_codes.forEach((ec) => {
 
 });
 
-module.exports = Controller;
+export default Controller;

package/lib/firebase_connector.js

@@ -1,8 +1,11 @@
 // TODO: multiple async requests here... need to
 // consider how this will be used by the models
-var EventEmitter = require('events').EventEmitter;
-const MongoClient = require('mongodb').MongoClient;
-const test = require('assert');
+import {EventEmitter} from 'node:events';
+// var EventEmitter = require('events').EventEmitter;
+import { MongoClient } from 'mongodb';
+// const MongoClient = require('mongodb').MongoClient;
+// const test = require('assert');
+import test from 'assert';
 
 module.exports = MongoDBConnector;
 

package/lib/model.js

@@ -3,8 +3,10 @@
 // should use promise objects to allow for method chaining
 // eventful.  emits ready event passing itself
 // start with mongodb
-module.exports = Model;
-var util = require('util');
+import util from 'util';
+import controller_base from './controller.js';
+// var controller_base = require('./controller.js');
+// var util = require('util');
 
 /** TODO: what persistence methods does a model need?
  *  save/post => saves record to db
@@ -34,7 +36,6 @@ var util = require('util');
 
 // init references to model base objects for use by controllers
 // and models
-var controller_base = require('./controller.js');
 controller_base.prototype.models = {};
 Model.prototype.models = {};
 
@@ -47,7 +48,7 @@ var NAME_REQUIRED_ERROR = function() {
     );
 }
 
-function Model(){
+export default function Model(){
 };
 
 Model.extend = function(constructor) {

package/lib/model_v2.js

@@ -1,6 +1,6 @@
 let dbConnector = null;
 
-class Model {
+export default class Model {
   static setConnector(connector) {
     if (!dbConnector) dbConnector = connector;
   }
@@ -9,5 +9,3 @@ class Model {
     return dbConnector.generateModelSuperclass(modelName, connectorOptions);
   }
 }
-
-module.exports = Model;

package/lib/mongodb_connector.js

@@ -1,10 +1,11 @@
 // TODO: multiple async requests here... need to
 // consider how this will be used by the models
-var EventEmitter = require('events').EventEmitter;
-const MongoClient = require('mongodb').MongoClient;
-const test = require('assert');
+import {EventEmitter} from 'node:events';
+// var EventEmitter = require('events').EventEmitter;
+// const MongoClient = require('mongodb').MongoClient;
+import { MongoClient } from 'mongodb';
 
-module.exports = MongoDBConnector;
+export default MongoDBConnector;
 
 // TODO: need to deal with clustered databases...
 

package/lib/mongoose_connector.js

@@ -1,4 +1,5 @@
-const mongoose = require('mongoose');
+// const mongoose = require('mongoose');
+import mongoose from 'mongoose';
 
 class MongooseDbConnector {
   async connect(options) {
@@ -23,7 +24,7 @@ class MongooseDbConnector {
     return this.connection.model(name, options.schema);
   }
 }
-module.exports = MongooseDbConnector;
+export default MongooseDbConnector;
 /*
 module.exports.connect = function(options) {
   if (options.uri) return mongoose.createConnection(options.uri, mongooseOptions);

package/lib/mongoose_mem_connector.js

@@ -1,16 +1,21 @@
 // const mongoose = require('mongoose');
-const {MongoMemoryServer} = require('mongodb-memory-server');
+// const {MongoMemoryServer} = require('mongodb-memory-server');
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import MongooseDbConnector from './mongoose_connector.js';
+// const MongooseDbConnector = require('./mongoose_connector');
 
-const MongooseDbConnector = require('./mongoose_connector');
-
-class MongooseMemoryConnector extends MongooseDbConnector {
+export default class MongooseMemoryConnector extends MongooseDbConnector {
 
   async connect() {
-    const mongod = await MongoMemoryServer.create();
-    const uri = mongod.getUri();
-    console.error("The URI", uri);
-    const dbConfig = {uri: uri};
-    return super.connect(dbConfig);
+    try {
+      const mongod = await MongoMemoryServer.create();
+      const uri = mongod.getUri();
+      console.error("The URI", uri);
+      const dbConfig = {uri: uri};
+      return super.connect(dbConfig);
+    } catch (e) {
+      console.error("Could not connect to MongoMemoryServer");
+      console.error(e);
+    }
   }
-}
-module.exports = MongooseMemoryConnector;
+}

package/lib/nails.js

@@ -1,18 +1,25 @@
 // The file which configures the nails application
-const http = require('http');
-const https = require('https');
-const URL = require('url');
-const path = require('path');
-const fs = require('fs');
-const domain = require('domain');
-const EventEmitter = require('events').EventEmitter;
+import http from 'node:http';
+import https from 'node:https';
+import URL from 'node:url';
+import path from 'node:path';
+import fs from 'node:fs';
+import { EventEmitter } from 'node:events';
 
-const Controller = require('./controller.js');
-const Model = require('./model.js');
-const ModelV2 = require('./model_v2.js');
-const Router = require('./router.js');
+// const http = require('http');
+// const https = require('https');
+// const URL = require('url');
+// const path = require('path');
+// const fs = require('fs');
+// const EventEmitter = require('events').EventEmitter;
 
-const express_app = require('./application.js');
+
+import Controller from './controller.js';
+import Model from './model.js';
+import ModelV2 from './model_v2.js';
+import Router from './router.js';
+
+import express_app from './application.js';
 
 const models = {};
 
@@ -22,11 +29,12 @@ application.config = {};
 
 // TODO: this should return a function (the configure function).
 // Calling the function should return { startServer: startServer }.
-module.exports = nails;
+// export defulat nails;
 
-function nails(app_config) {
+export default async function nails(app_config) {
   nails.config = app_config.config;
   application._onceConfigured = configure(app_config);
+  await application._onceConfigured;
   return {startServer: startServer};
 }
 
@@ -57,10 +65,13 @@ async function configure( app_config ) {
 
   // set up router and controllers
   express_app.set("public_root", app_config.config.PUBLIC_ROOT);
+  console.log("Initializing Router...");
   application.router = new Router( app_config.routes || [] );
+  console.log("Application Router initialized");
 
   // init models
-  var DBConnector = get_dbconnector(app_config.db.connector);
+  console.log("Initializing DB connection...");
+  var DBConnector = await get_dbconnector(app_config.db.connector);
 
   // TODO: deprecate the old Model style
   if (app_config.config.MODELS_ROOT) {
@@ -68,15 +79,19 @@ async function configure( app_config ) {
     init_models(app_config.config.MODELS_ROOT);
   }
   // TODO: make this Model style mandatory
+  console.log("Connecting to DB...");
   if (DBConnector.connect && DBConnector.generateModelSuperclass) {
+    console.log("Generating model superclass...");
     await DBConnector.connect(app_config.db);
     ModelV2.setConnector(DBConnector);
   } else {
+    console.log("Instantiating DBConnector...");
     // Try to instantiate DBConnector
     let dbConnector = new DBConnector();
     await dbConnector.connect(app_config.db);
     ModelV2.setConnector(dbConnector);
   }
+  console.log("DB Connection complete");
 
   // init Controllers
   Controller.setRouter(application.router);
@@ -88,7 +103,7 @@ async function configure( app_config ) {
 function startServer(config) {
     // Log the config.
     console.log(config);
-    //await application._onceConfigured;
+    // await application._onceConfigured;
     console.log("CONFIGURATION COMPLETE");
     // TODO: Use logging middleware.
     application._onceConfigured.then(() => {
@@ -155,14 +170,16 @@ async function init_app_lib(superclass, abs_path) {
 // require the module with the same name,
 // try grabbing connector from lib
 // (default connectors)
-function get_dbconnector(connector_name) {
+async function get_dbconnector(connector_name) {
+  console.log("Getting DBConnector:", connector_name);
     var DBConnector;
     //TODO: put mongodbconnector in its own module
     try {
-        DBConnector = require(connector_name);
+        DBConnector = (await import(connector_name)).default;
     } catch(e) {
-        DBConnector = require('./'+connector_name);
+        DBConnector = (await import('./'+connector_name)).default;
     }
+    console.log("Got DBConnector:", DBConnector.name);
     return DBConnector;
 }
 

package/lib/router.js

@@ -2,14 +2,25 @@
 // server-side logic based on the matching route in the Routing Table
 // ( See example/config/routes.js or config/routes.js for a description of the routes )
 
-var EventEmitter = require('events').EventEmitter;
-var URL = require('url');
-var path = require('path');
-var querystring = require('querystring');
-var expressWs = require('express-ws');
-var app = require('./application.js');
-//var nails = require('./nails.js');
-var _extend = require('util')._extend;
+import {EventEmitter} from 'node:events';
+// var EventEmitter = require('events').EventEmitter;
+import URL from 'node:url';
+// var URL = require('url');
+
+import path from 'node:path';
+import querystring from 'node:querystring';
+import express from 'express';
+import expressWs from 'express-ws';
+import app from './application.js'
+// TODO use modular js only
+import {_extend} from 'util';
+
+// var path = require('path');
+// var querystring = require('querystring');
+// var expressWs = require('express-ws');
+// var app = require('./application.js');
+// //var nails = require('./nails.js');
+// var _extend = require('util')._extend;
 
 /**
  *  Creates a Router from an Array of route definitions
@@ -39,10 +50,15 @@ class Router extends EventEmitter {
     if (Router.webSocketsEnabled) return;
     Router.webSocketsEnabled = true;
     Router.expressWs = expressWs(this.application);
+    expressWs(this.express_router);
+    // console.log("WS is still:", this.express_router.ws);
   }
-  constructor(routes, application) {
+  constructor(routes) {
     super();
-    this.application = application || app;
+    this.application = app;
+    // this.express_router = express.Router();
+    // console.log("the router is:", this.express_router);
+    // console.log("the ws is:", this.express_router.ws);
     this.express_router = app.Router();
     this.addRoutes(routes);
   }
@@ -56,14 +72,13 @@ class Router extends EventEmitter {
     var method = route[0].toLowerCase();
     var path_matcher = route[1];
     var consequences = route[2];
-    var is_public = consequences && consequences.public;
     console.log("setting route for", method, path_matcher, consequences);
-    if (method.match(/ws/i)) {
+    if (method.match(/ws/i)) { // For some reason this hangs
       this.enableWebSockets();
       this.express_router.ws(
         path_matcher,
         this.get_websocket_handler(consequences));
-    } else if (consequences && consequences.public)
+    } else if (consequences && consequences.public) // Is a request for public asset
       this.express_router.use(path_matcher,
           this.application.static(this.application.get('public_root')));
     else this.express_router[method](path_matcher,
@@ -184,4 +199,4 @@ class Router extends EventEmitter {
   }
 }
 
-module.exports = Router;
+export default Router;

package/lib/sqlite3_connector.js

@@ -1,8 +1,11 @@
 // TODO: multiple async requests here... need to
 // consider how this will be used by the models
-var EventEmitter = require('events').EventEmitter;
-const DBClient = require('sqlite3');
-const test = require('assert');
+import { EventEmitter } from 'events';
+import DBClient from 'node:sqlite';
+// var EventEmitter = require('events').EventEmitter;
+// const DBClient = require('sqlite3');
+import test from 'node:assert';
+// const test = require('assert');
 
 module.exports = SQLite3Connector;
 

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "nails-boilerplate",
-  "version": "0.14.3",
+  "version": "1.0.0",
   "description": "A node.js webserver scaffold",
+  "type": "module",
   "main": "index.js",
   "bin": {
     "nails": "./bin/lib/nails.js"
   },
   "scripts": {
+    "copyreadme": "mammoth README.md templates/client/README.html",
     "test": "mocha --exit spec",
     "debug": "mocha --exit debug spec"
   },
@@ -25,10 +27,9 @@
   "dependencies": {
     "@babel/core": "*",
     "@babel/preset-react": "*",
-    "body-parser": "^1.20.2",
+    "body-parser": "^2.2.0",
     "ejs": "*",
     "express": "*",
-    "express-react-views": "*",
     "express-ws": "*",
     "mime": "*",
     "mongodb": "^4.17.2",
@@ -36,6 +37,7 @@
     "mongoose": "^6.13.0",
     "react": "*",
     "react-dom": "^16.13.1",
+    "showdown": "^2.1.0",
     "wrench": "*"
   },
   "devDependencies": {

package/spec/controller.spec.js

@@ -1,7 +1,8 @@
-var Controller = require('../lib/controller.js');
-var assert = require('assert');
-const sinon = require('sinon');
-var EventEmitter = require('events').EventEmitter;
+import Controller from '../lib/controller.js';
+import assert from 'assert';
+import sinon from 'sinon';
+import {EventEmitter} from 'node:events';
+
 function TestController() {
     this.testAction = function () {};
 };
@@ -24,12 +25,12 @@ describe('Controller', function() {
   describe('Controller.constructor', function() {
     it('should set the appropriate listener on the router',
         function() {
-      mockRouter = new EventEmitter();
-      mockParams = {_controller: "test"};
-      mockRequest = {};
-      mockResponse = {headersSent: true};
+      let mockRouter = new EventEmitter();
+      let mockParams = {_controller: "test"};
+      let mockRequest = {};
+      let mockResponse = {headersSent: true};
       Controller.setRouter(mockRouter);
-      testController = new TestEs6Controller();
+      let testController = new TestEs6Controller();
       sinon.spy(testController, "testEs6Action");
 
       mockRouter.emit(
@@ -42,7 +43,7 @@ describe('Controller', function() {
   describe('Controller.extend', function() {
     it('should error if an anonymous function is passed', function() {
       try {
-        testController = Controller.extend(function(){});
+        let testController = Controller.extend(function(){});
         assert(false); // Fail if we get here.
       } catch(e) {
       }
@@ -50,12 +51,12 @@ describe('Controller', function() {
 
     it('should set the appropriate listener on the router',
         function() {
-      mockRouter = new EventEmitter();
-      mockParams = {_controller: "test"};
-      mockRequest = {};
-      mockResponse = {headersSent: true};
+      let mockRouter = new EventEmitter();
+      let mockParams = {_controller: "test"};
+      let mockRequest = {};
+      let mockResponse = {headersSent: true};
       Controller.setRouter(mockRouter);
-      testController = Controller.extend(TestController);
+      let testController = Controller.extend(TestController);
       sinon.spy(testController, "testAction");
 
       mockRouter.emit(
@@ -66,21 +67,21 @@ describe('Controller', function() {
     });
     it('should set itself as the prototype of the passed constructor method',
       function() {
-        mockRouter = new EventEmitter();
+        let mockRouter = new EventEmitter();
         Controller.setRouter(mockRouter);
-        testController = Controller.extend(TestController);
+        let testController = Controller.extend(TestController);
         assert(testController instanceof Controller);
       }
     );
     it('should return an initialized instance of the constructor', function() {
-      mockRouter = new EventEmitter();
+      let mockRouter = new EventEmitter();
       Controller.setRouter(mockRouter);
-      testController = Controller.extend(TestController);
+      let testController = Controller.extend(TestController);
       assert(testController instanceof TestController);
     });
     it('should raise an error if no router has been set', function() {
       try {
-        testController = Controller.extend(TestController);
+        let testController = Controller.extend(TestController);
         assert(false); // Fail if we get here.
       } catch (expectedError) {
       }

package/spec/model.spec.js

@@ -1,6 +1,6 @@
-const assert = require('assert');
-const Model = require('../lib/model.js');
-const MongoDBConnectorUtil = require("./mongodb_connector.util.js");
+import assert from 'assert';
+import Model from '../lib/model.js';
+import MongoDBConnectorUtil from './mongodb_connector.util.js';
 
 var test_model = new Model();
 var model_prot = Model.prototype;

package/spec/model_v2.spec.js

@@ -1,6 +1,6 @@
-const assert = require('assert');
-const Model = require('../lib/model_v2.js');
-const MongooseConnectorUtil = require("./mongoose_connector.util.js");
+import assert from 'assert';
+import Model from '../lib/model_v2.js';
+import MongooseConnectorUtil from './mongoose_connector.util.js';
 
 const testSchema = {
   name: String,

package/spec/mongodb_connector.spec.js

@@ -1,5 +1,5 @@
-var assert = require('assert');
-const MongoDBConnectorUtil = require("./mongodb_connector.util.js");
+import assert from 'assert';
+import MongoDBConnectorUtil from './mongodb_connector.util.js';
 
 describe('MongoDBConnector', function() {
   var util;