@projectinvicta/nails 2.0.15 → 3.0.0

package/spec/services/integration/config/service.js

@@ -3,7 +3,7 @@
 
 import routes from './routes.js';
 import mimes from './mimes.js';
-import db from './db.js';
+import db from './db.ts';
 
 var SERVER_ROOT = import.meta.dirname + '/..';
 var APP_ROOT = SERVER_ROOT + '/server';
@@ -14,13 +14,13 @@ import fs from 'node:fs';
 const PRIVATE_KEY_FILE = fs.readFileSync(`${import.meta.dirname}/ssl/key.pem`);
 const CERTIFICATE_FILE = fs.readFileSync(`${import.meta.dirname}/ssl/certificate.pem`);
 
-var config = {
+var service = {
   APP_ROOT: APP_ROOT,
   // root directory for delivering static assets
   PUBLIC_ROOT: SERVER_ROOT + '/client',
   CONTROLLERS_ROOT: APP_ROOT + '/controllers',
   VIEWS_ROOT: APP_ROOT + '/views',
-  //MODELS_ROOT: APP_ROOT + '/models',
+  MODELS_ROOT: APP_ROOT + '/models',
   SERVER_ROOT: SERVER_ROOT,
 
   ENABLE_HTTP: true,
@@ -30,10 +30,10 @@ var config = {
   ASYNC: false,
 
   // For HTTPS
-  ENABLE_HTTPS: true,
-  SSL_PORT: 3334,
-  PRIVATE_KEY: PRIVATE_KEY_FILE,
-  CERTIFICATE: CERTIFICATE_FILE,
+  ENABLE_HTTPS: false,
+  // SSL_PORT: 3334,
+  // PRIVATE_KEY: PRIVATE_KEY_FILE,
+  // CERTIFICATE: CERTIFICATE_FILE,
 };
 
 // module.exports.routes = require('./routes.js');
@@ -41,7 +41,7 @@ var config = {
 // module.exports.db = require('./db.js');
 
 export default {
-  config,
+  service,
   routes,
   db,
   mimes,

package/spec/services/integration/server/controllers/classbased_controller.js

@@ -1,6 +1,6 @@
-import nails from "../../../../../index.js";
+import nails, {Controller} from "../../../../../index.ts";
     // require("../../../../../index.js").Controller;
-export default class ClassbasedController extends nails.Controller {
+export default class ClassbasedController extends Controller {
   routes = [
     ["get", "./arbi/trary/testLocalRoutes", {action: 'testLocalRoutes', json: true}],
     ["get", "arbi00/trary00/testLocalRoutes", {action: 'testLocalRoutes', json: true}],

package/spec/services/integration/server/controllers/default_json_controller.js

@@ -1,20 +1,32 @@
-import nails from "../../../../../index.js";
+import { Controller } from "../../../../../index.ts";
+import Dog from "../models/dog.js";
+import Owner from "../models/owner.js";
 
-export default class DefaultJsonController extends nails.Controller {
+export default class DefaultJsonController extends Controller {
   json = true;
   routes = [
     ['get', 'arbi/trary/testautoaction'],
-    ['get', 'arbi/trary/testautojson', {action: 'testautojson'}],
-    ['get', 'arbi/trary/testjsonoverridden', {action: 'testnojson', json: false}],
+    ['get', 'arbi/trary/testautojson', { action: 'testautojson' }],
+    ['get', 'arbi/trary/testjsonoverridden', { action: 'testnojson', json: false }],
+    ['get', '/listowners'],
+    ['get', '/listowneddogs'],
   ];
 
   testautoaction(params, request, response) {
-    return {json_testautoaction: true};
+    return { json_testautoaction: true };
   }
 
   testautojson(params, request, response) {
-    return {json_testautojson: true};
+    return { json_testautojson: true };
   }
 
-  testnojson(params, request, response) {}
+  testnojson(params, request, response) { }
+
+  async listowners(params, request, response) {
+    return await Owner.findAll();
+  }
+
+  async listowneddogs(params, request, response) {
+    return await Dog.findAll();
+  }
 }

package/spec/services/integration/server/controllers/error_controller.js

@@ -1,6 +1,6 @@
-import nails from "../../../../../index.js";
+import nails, {Controller} from "../../../../../index.ts";
 
-export default class ErrorController extends nails.Controller {
+export default class ErrorController extends Controller {
   // DO NOT OVERRIDE CONSTRUCTOR
   index(params, request, response) {
     response.json({

package/spec/services/integration/server/controllers/home_controller.js

@@ -1,39 +1,17 @@
-export default function HomeController() {
-  this.index = function(params, request, response) {
+import { Controller } from "../../../../../index.ts";
+
+export default class HomeController extends Controller {
+  index(params, request, response) {
     console.log("HOME::INDEX");
     response.json({
       home_index: true
     });
   };
-  this.testaction = function(params, request, response) {
+  testaction(params, request, response) {
     response.json({
       home_testaction: true
     });
   }
-  this.test_ejs = function() {
-  };
-/*
-  this.public_index = function(params, request, response) {
-    response.public({path: 'index.html'});
-  };
-  this.json = function(params, request, response) {
-    response.json({test: 'json'});
-  };
-  // By setting a method to asynchronous, Nails will wait for an
-  // explicit response to the client. Otherwise, it will attempt
-  // to respond with a view immediately after the action terminates.
-  this.json.async = true;
-
-  this.test_model = function(params, request, response) {
-    var u = new User();
-    u.set('created_at', (new Date()).getTime());
-    u.save();
-    response.json({new_user_id: u.id.toString()});
-  };
-  this.test_id_template = function(params, request, response) {
-    var varz = {};
-    varz.id = params.id || "no id set";
-    response.render('test_id', varz);
+  test_ejs() {
   };
-  */
 }

package/spec/services/integration/server/controllers/json_controller.js

@@ -1,6 +1,6 @@
-import nails from "../../../../../index.js";
+import {Controller} from "../../../../../index.ts";
 
-export default class JsonController extends nails.Controller {
+export default class JsonController extends Controller {
   testparams(params, request, response) {
     // should just render the params as JSON
   }

package/spec/services/integration/server/controllers/manualrenderasync_controller.js

@@ -1,5 +1,5 @@
-import nails from "../../../../../index.js";
-export default class ManualRenderAsyncController extends nails.Controller {
+import {Controller} from "../../../../../index.ts";
+export default class ManualRenderAsyncController extends Controller {
   testmanualrenderasync(params, request, response) {
     return new Promise((resolve, reject) => {
       response.json({json_testmanualrenderasync: true});

package/spec/services/integration/server/controllers/mjs_controller.mjs

@@ -1,9 +1,5 @@
-/*
-const Controller =
-    require("../../../../../index.js").Controller;
-    */
-import nails from "../../../../../index.js";
-export default class MjsController extends nails.Controller {
+import {Controller} from "../../../../../index.ts";
+export default class MjsController extends Controller {
   // DO NOT OVERRIDE CONSTRUCTOR
   index(params, request, response) {
     response.json({

package/spec/services/integration/server/controllers/modeltest_controller.js

@@ -1,18 +1,15 @@
-import nails from "../../../../../index.js";
+import nails from "../../../../../index.ts";
 import Dog from "../models/dog.js";
 
 export default class ModeltestController extends nails.Controller {
   async createdog(params, request, response) {
-    let dog = new Dog({good: true, name: params.name});
-    await dog.save();
-    return dog._id.toString();
+    let dog = await Dog.create({good: true, name: params.name});
+    console.log("CREATED DOG ID:", dog.id);
+    return dog.id.toString();
   }
 
   async getdogbyid(params, request, response) {
-    let dog = await Dog.findById(params.id);
-    return {
-      name: dog.name,
-      good: dog.good
-    };
+    console.error("DOG ID IS:", params.id);
+    return await Dog.findByPk(params.id);
   }
 }

package/spec/services/integration/server/controllers/websocket_controller.js

@@ -1,4 +1,4 @@
-import nails from "../../../../../index.js";
+import nails from "../../../../../index.ts";
 
 export default class WebsocketController extends nails.Controller {
   index(params, ws, request) {

package/spec/services/integration/server/models/dog.js

@@ -1,6 +1,8 @@
-import nails from '../../../../../index.js';
-const dogSchema = {
-  good: Boolean,
-  name: String
+import {Model, DataTypes} from '../../../../../index.ts';
+
+export const schema = {
+  good: DataTypes.BOOLEAN,
+  name: DataTypes.STRING,
 };
-export default class Dog extends new nails.Model("Dog", {schema: dogSchema}) {};
+
+export default class Dog extends Model {};

package/spec/services/integration/server/models/owner.js

@@ -0,0 +1,13 @@
+import {Model} from '../../../../../index.ts';
+import { DataTypes } from 'sequelize';
+import Dog from './dog.js';
+
+export const schema = {
+  name: DataTypes.STRING,
+};
+export default class Owner extends Model {};
+
+export async function defer() {
+  Owner.hasMany(Dog);
+  await Dog.sync({alter: {drop: false}});
+}

package/spec/services/integration/server.js

@@ -1,9 +1,8 @@
-// var nails = require('../../../index.js');
-import nails from '../../../index.js';
+import Nails from '../../../index.ts';
 import service_config from './config/service.js';
 
 // See self-documented config files
 // var service_config = require('./config/service.js');
-// console.log("starting server")
-(await nails( service_config )).startServer();
+const nails = new Nails(service_config);
+await nails.startServer();
 export default nails; // export nails for testing

package/spec/services.integration.spec.js

@@ -7,6 +7,7 @@ import { assert } from 'chai';
 import WebSocket from 'ws';
 // const WebSocket = require('ws');
 
+let nails;
 var express_app;
 // const {MongoMemoryServer} = require('mongodb-memory-server');
 let mongod = null;
@@ -19,7 +20,7 @@ describe("Integration: Sequelize", function () {
   before(async function () {
     // this.timeout(30000);
     try {
-      var nails = (await import('./services/integration/server.js')).default;
+      nails = (await import('./services/integration/server.js')).default;
     } catch (e) {
       console.log("could not import server");
       console.log(e);
@@ -27,6 +28,28 @@ describe("Integration: Sequelize", function () {
     console.log("got here");
     express_app = nails.application;
   });
+  describe("/listowners", function () {
+    it('should return an empty array if no owners', function (done) {
+      request.execute(express_app)
+        .get('/listowners')
+        .end((err, res) => {
+          res.should.have.status(200);
+          assert(JSON.parse(res.text).length == 0);
+          done();
+        });
+    })
+  })
+  describe("/listowneddogs", function () {
+    it('should return an empty array if no owned dogs', function (done) {
+      request.execute(express_app)
+        .get('/listowneddogs')
+        .end((err, res) => {
+          res.should.have.status(200);
+          assert(JSON.parse(res.text).length == 0);
+          done();
+        });
+    })
+  })
   describe("GET /", function () {
     it('should return the expected JSON from index', function (done) {
       request.execute(express_app)
@@ -79,7 +102,7 @@ describe("Integration: Sequelize", function () {
     });
   });
   describe("Get /defaultjson/arbi/trary", function () {
-    it("Should default to json if not present in route options", function(done) {
+    it("Should default to json if not present in route options", function (done) {
       request.execute(express_app)
         .get('/defaultjson/arbi/trary/testautojson')
         .end((err, res) => {
@@ -88,7 +111,7 @@ describe("Integration: Sequelize", function () {
           done();
         });
     });
-    it("Should autoassign the action if not present in route options", function(done) {
+    it("Should autoassign the action if not present in route options", function (done) {
       request.execute(express_app)
         .get('/defaultjson/arbi/trary/testautoaction')
         .end((err, res) => {
@@ -97,7 +120,7 @@ describe("Integration: Sequelize", function () {
           done();
         });
     });
-    it("Should not render json if route options explicitly say not to", function(done) {
+    it("Should not render json if route options explicitly say not to", function (done) {
       request.execute(express_app)
         .get('/defaultjson/arbi/trary/testjsonoverridden')
         .end((err, res) => {
@@ -205,17 +228,18 @@ describe("Integration: Sequelize", function () {
   });
 
   describe("GET /json/:action", function () {
+    // TODO: Do we really want this behavior?
     it('should render params if nothing is returned by the action',
-      function (done) {
-        request.execute(express_app)
-          // Route to index action.
-          .get('/json/testparams?testkey=testvalue')
-          .end((err, res) => {
-            res.should.have.status(200);
-            assert(JSON.parse(res.text).testkey == "testvalue");
-            done();
-          });
-      }
+      // function (done) {
+      //   request.execute(express_app)
+      //     // Route to index action.
+      //     .get('/json/testparams?testkey=testvalue')
+      //     .end((err, res) => {
+      //       res.should.have.status(200);
+      //       assert(JSON.parse(res.text).testkey == "testvalue");
+      //       done();
+      //     });
+      // }
     );
     it('should render the returned object as json', function (done) {
       request.execute(express_app)
@@ -281,12 +305,16 @@ describe("Integration: Sequelize", function () {
         .get(`/modeltest/createdog?name=${dogName}`)
         .end((err, res) => {
           res.should.have.status(200);
-          dogId = res.text.replaceAll('"', '');
+          dogId = res.text.replaceAll("\"", "");
           request.execute(express_app)
             .get(`/modeltest/getdogbyid?id=${dogId}`)
             .end((err, res) => {
-              assert.equal(
-                res.text, JSON.stringify({ name: dogName, good: true }));
+              const dogOnServer = JSON.parse(res.text);
+              assert.equal(dogOnServer.name, dogName);
+              assert.isTrue(dogOnServer.good);
+              assert.isDefined(dogOnServer.id);
+              assert.isDefined(dogOnServer.createdAt);
+              assert.isDefined(dogOnServer.updatedAt);
               done();
             });
         });

package/templates/default/config/db.ts

@@ -0,0 +1,13 @@
+import { type DbConfig } from '@projectinvicta/nails';
+
+let DB_ADDRESS = process.env.NAILS_SQLITE_DB_FILE;
+if (!DB_ADDRESS) DB_ADDRESS = 'sqlite://' + import.meta.dirname + '/development.db';
+
+const db: DbConfig = {
+  /** Sequelize Connector */
+  address: process.env.NAILS_RELEASE_STAGE == 'test'
+    ? 'sqlite::memory:'
+    : DB_ADDRESS,
+};
+
+export default db;

package/{spec/services/integration_sequelize/config/mimes.js → templates/default/config/mimes.ts}

@@ -1,61 +1,42 @@
-/**
- *  This file uses file extensions in the request to determine
- *  the type of an asset and, therefore, where it can be found
- *  in the file system.
- *
- *  Currently, the supported types are: 'js', 'css', 'html',
- *  'img'
- *  TODO: Add supported types pdf ( or document ), and video
- *  TODO: move this file into nails.  Too annoying for the dev
- *  to see and they shouldn't need to have to change it
- */
- /*
-    var mimes = {
-    // <ext>: '<type>'
-        js: 'js',
-        jpg: 'image',
-        css: 'css',
-        html: 'html'
-    };
-    */
-
-var mimes = {
-    html: {
-        type: 'page',
-        contentType: 'text/html'
-    },
-    js: {
-        type: 'script', // the type of the script,
-        contentType: 'application/javascript' // Header info
-    },
-    css: {
-        type: 'style',
-        contentType: 'text/css'
-    },
-    ico: {
-        type: 'image',
-        contentType: 'image/x-icon'
-    },
-    jpg: {
-        type: 'image',
-        contentType: 'image/jpeg'
-    },
-    png: {
-        type: 'image',
-        contentType: 'image/png'
-    },
-    pdf: {
-        type: 'document',
-        contentType: 'application/pdf'
-    },
-    xml: {
-        type: 'data',
-        contentType: 'text/xml'
-    },
-    json: {
-        type: 'data',
-        contentType: 'application/json'
-    }
-}
-
-export default mimes;
+import { type MimesConfig } from '@projectinvicta/nails';
+
+const mimes: MimesConfig = {
+    html: {
+        type: 'page',
+        contentType: 'text/html'
+    },
+    js: {
+        type: 'script', // the type of the script,
+        contentType: 'application/javascript' // Header info
+    },
+    css: {
+        type: 'style',
+        contentType: 'text/css'
+    },
+    ico: {
+        type: 'image',
+        contentType: 'image/x-icon'
+    },
+    jpg: {
+        type: 'image',
+        contentType: 'image/jpeg'
+    },
+    png: {
+        type: 'image',
+        contentType: 'image/png'
+    },
+    pdf: {
+        type: 'document',
+        contentType: 'application/pdf'
+    },
+    xml: {
+        type: 'data',
+        contentType: 'text/xml'
+    },
+    json: {
+        type: 'data',
+        contentType: 'application/json'
+    }
+};
+
+export default mimes;

package/templates/default/config/routes.ts

@@ -0,0 +1,22 @@
+import { type RoutesConfig } from '@projectinvicta/nails';
+
+const routes: RoutesConfig = [
+	// Routes the root request to index.html, as well as all other requests to static
+  ['get', "/", {controller: 'home'}],
+  // Routes all requests starting with /public as static requests to the public folder.
+  ['get', '/public', {public: true}],
+
+	// A test route which routes the first part of pathname to controller and the second to the action
+	// ['get', /^\/(\w+)\/(\w+)$/i, {0: 'controller', 1: 'action'}],
+
+  // Maps the first two parts of the path to controller and action, and the third to the id parameter
+  // ['get', "/:controller/:action/:id"],
+
+  // For all other GET requests, render HomeController#index
+  ['get', '/:catchall', {controller: 'home'}],
+
+  // Defines a WebSocket handler
+  // ['ws', "/:controller/:action/:id"]
+];
+
+export default routes;

package/templates/{config/service.js → default/config/service.ts}

@@ -13,7 +13,7 @@ import fs from 'node:fs';
 const PRIVATE_KEY_FILE = fs.readFileSync(`${import.meta.dirname}/ssl/key.pem`);
 const CERTIFICATE_FILE = fs.readFileSync(`${import.meta.dirname}/ssl/certificate.pem`);
 
-var config = {
+var service = {
   APP_ROOT: APP_ROOT,
   // root directory for delivering static assets
   PUBLIC_ROOT: SERVER_ROOT + '/public',
@@ -38,7 +38,7 @@ var config = {
 };
 
 export default {
-  config,
+  service,
   routes,
   mimes,
   db

package/templates/default/package.json

@@ -22,17 +22,23 @@
             "version": "latest"
         }
     },
+    "imports": {
+      "#models/*": "./server/models/*",
+      "#common/*": "./common/*",
+      "#config/*": "./config/*"
+    },
     "dependencies": {
+        "@projectinvicta/nails": "*",
         "@mui/icons-material": "^7.3.1",
         "@mui/material": "^7.3.1",
         "@vitejs/plugin-legacy": "^6.1.1",
         "@vitejs/plugin-react": "^4.7.0",
-        "nails-boilerplate": ">=1.1.0",
         "react": "^19.1.0",
         "react-dom": "^19.1.0",
         "react-router-dom": "^7.7.0",
         "sequelize": "^6.37.7",
-        "vite": "^6.3.5"
+        "vite": "^6.3.5",
+        "chai-http": "*"
     },
     "devDependencies": {
         "@emotion/react": "^11.14.0",