nodester 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mark Khramko
+
+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,125 @@
+# nodester
+>  A robust boilerplate framework that makes iterative development easy.
+
+## Table of Contents
+
+- [Usage](#usage)
+- [Extending](#extending-application-functionality)
+- [Philosophy](#philosophy)
+- [License](#license)
+- [Copyright](#copyright)
+
+## Usage
+
+```js
+const nodester = require('nodester');
+const db = require('#db');
+
+const app = new nodester();
+app.set.database(db);
+
+app.listen(8080, function() {
+	console.log('listening on port', app.port);
+});
+```
+
+## Markers
+
+Marker is a functional condition that returns `true | false`, based on data in request.
+
+
+### Adding a Marker
+
+```js
+app.add.marker('admin', (req) => req.role === 'admin');
+```
+
+
+### Using a Marker
+
+```js
+app.only('admin').route('get /payments', <handler>);
+app.only('/api').route('get /payments', <handler>);
+```
+
+
+## Router
+
+```js
+app.route('get /books', function(req, res) { ... } );
+app.route('get /books', { controlledBy: 'BooksController.getMany' } );
+app.route('get /books/:id', { controlledBy: 'BooksController.getOne' } );
+```
+
+
+## Extending Application functionality
+
+
+### Extending instance (safe way):
+
+```js
+const serveStatic = require('serve-static');
+
+const nodester = require('nodester');
+
+const app = nodester();
+app.extend('static', serveStatic);
+app.static(<path_to_static_directory>);
+```
+
+Short:
+```js
+const serveStatic = require('serve-static');
+
+const nodester = require('nodester');
+
+const app = nodester();
+app.extend('static', serveStatic)(<path_to_static_directory>);
+```
+
+Of course you might just do this:
+```js
+const serveStatic = require('serve-static');
+
+const nodester = require('nodester');
+
+const app = nodester();
+app.static = serveStatic;
+````
+But you'll never know if you did override any of the app's properties or did not.
+
+
+### Extending class:
+
+If you really want to override properties or use `nodester` as a boilerplate, you should better extend default Application class:
+
+```js
+const DefaultApplication = require('nodester');
+
+class MyApp extends DefaultApplication {
+	constructor(opts) {
+		super(opts)
+	}
+
+	// Override everything you want here...
+}
+
+// Don't forget to expose.
+module.exports = MyApp;
+```
+
+## Philosophy
+
+The Philosophy of `nodester` is to provide a developer with a tool that can build an app (or feature) in hours and scale it with ease for years.
+
+### Goal
+
+The goal of `nodester` is to be a robust boilerplate that makes iterative development easy.
+
+
+## LICENSE
+
+MIT
+
+## Copyright
+Copyright 2021-present [Mark Khramko](https://github.com/MarkKhramko)

package/docs/App.md

@@ -0,0 +1,13 @@
+# nodester Application
+
+## Init
+
+```js
+	const nodester = require('nodester');
+	
+	const app = new nodester();
+
+	app.listen(8080, function() {
+		console.log('listening on port', app.port);
+	});
+```

package/docs/Queries.md

@@ -0,0 +1,61 @@
+# nodester Queries API
+
+## Like value
+
+To emulate MySQL's `like %value% ` query in URL,
+pass `?key=like(value)` in the query.
+
+* Example:
+`http://localhost:5001/api/v1/countries?name=like(Engl)`
+
+
+## NotLike value
+
+* Example:
+`http://localhost:5001/api/v1/countries?name=notLike(Engl)`
+
+
+## Or
+
+To emulate MySQL's `where key=value or key=value` query in URL,
+pass `?key=or(value1,value2)` in the query.
+* ! Note: don't use `spaces` between values.
+
+* Example:
+`http://localhost:5001/api/v1/countries?name=or(England,Germany)`
+
+
+## Count
+
+MySQL's `select count(value)` query is run by default in facade's `getMany` function
+
+* Response Example:
+```JSON
+{
+	"count": 10,
+	"countries": [ ... ],
+	"limit": 10,
+	"skip": 0,
+	"total_count": 195
+}
+```
+
+## Order (Sorting)
+
+
+#### Top level
+
+`order_by` & `order` arguments can be set in `query`
+`http://localhost:5001/api/v1/countries?order_by=id&order=desc`
+
+Above `query` will sort Countries[] by it's id.
+
+
+#### Nested (Includes)
+
+`http://localhost:5001/api/v1/countries?includes=cities(order_by=id&order=desc)`
+
+Above `query` will sort Cities[] by it's id inside every Country object.
+
+It can also do this:
+`http://localhost:5001/api/v1/countries?includes=cities(order_by=id&order=desc).areas`

package/docs/Readme.md

@@ -0,0 +1,2 @@
+# nodester API description
+

package/docs/Routing.md

@@ -0,0 +1,34 @@
+# nodester Routing
+
+1) Extend default `nodester` router
+```js
+const Router = require('nodester/router');
+
+class apiRouter extends Router {
+	constructor() {
+		super(opts);
+		this.add.controllers(<path_to_your_controllers>);
+		this.add.controllers(<path_to_your_controllers>, { namespace: 'view' });
+
+		this.add.routes()
+	}
+}
+```
+
+Root namespace is named `__root`
+
+2) Define routes
+```js
+module.exports = {
+	'GET /posts': { controlledBy: 'PostsController.getMany' },
+
+	// For different namespace:
+	'GET /view/posts': { controlledBy: '@view PostsViewController.getMany' },
+	// Can also be written as:
+	'GET /view/posts': {
+		namespace: 'view',
+		controller: 'PostsViewController'
+		action: 'getMany'
+	},
+}
+```

package/examples/goal/index.js

@@ -0,0 +1,23 @@
+const nodester = require('nodester');
+const db = require('#db');
+
+// Init.
+const app = new nodester();
+
+
+app.set.database(db);
+
+app.extend('static')
+
+app.static(<path/>);
+
+// Markers.
+app.add.marker('admin', (req)=>req.token.role === 'admin');
+
+// Using Markers.
+app.only('admin')
+	 .route('get /payments', (req, res, next) => {});
+
+app.listen(8080, function() {
+	console.log('listening on port', app.port);
+});

package/examples/rest/index.js

@@ -0,0 +1,25 @@
+const Nodester = require('nodester');
+
+// Init.
+const app = new Nodester();
+
+// app.setDatabase();
+// app.set('database');
+
+// app.add('marker', 'GET_M', (req)=>req.method === 'GET');
+
+app.add.middleware((req, res, next)=>{
+	console.log('1st');
+
+	res.setHeader("Content-type", "text/html");
+	res.write("Hello!<br/>...my friend");
+	res.end();
+})
+
+app.beforeStart(()=>{
+	console.log('Before start passed!');
+});
+
+app.listen(8080, function() {
+	console.log('listening on port', app.port);
+});

package/examples/rest/node_modules/.package-lock.json

@@ -0,0 +1,40 @@
+{
+  "name": "nodester-example-rest",
+  "version": "1.0.0",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "../..": {
+      "version": "0.6.1",
+      "license": "MIT",
+      "dependencies": {
+        "accepts": "^1.3.8",
+        "content-disposition": "^0.5.4",
+        "content-type": "^1.0.5",
+        "cookie": "^0.5.0",
+        "cookie-signature": "^1.2.0",
+        "debug": "^4.3.4",
+        "finalhandler": "^1.2.0",
+        "formidable": "^1.2.6",
+        "inflection": "^2.0.1",
+        "proxy-addr": "^2.0.7",
+        "qs": "^6.11.0",
+        "sequelize": "^6.6.5",
+        "serve-static": "^1.15.0",
+        "slugify": "^1.6.5",
+        "type-is": "^1.6.18",
+        "vary": "^1.1.2"
+      },
+      "devDependencies": {
+        "jest": "^29.4.2"
+      },
+      "engines": {
+        "node": ">= 12.17.0"
+      }
+    },
+    "node_modules/nodester": {
+      "resolved": "../..",
+      "link": true
+    }
+  }
+}

package/examples/rest/package-lock.json

@@ -0,0 +1,72 @@
+{
+  "name": "nodester-example-rest",
+  "version": "1.0.0",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "nodester-example-rest",
+      "version": "1.0.0",
+      "license": "MIT",
+      "dependencies": {
+        "nodester": "file:../../"
+      }
+    },
+    "../..": {
+      "version": "0.6.1",
+      "license": "MIT",
+      "dependencies": {
+        "accepts": "^1.3.8",
+        "content-disposition": "^0.5.4",
+        "content-type": "^1.0.5",
+        "cookie": "^0.5.0",
+        "cookie-signature": "^1.2.0",
+        "debug": "^4.3.4",
+        "finalhandler": "^1.2.0",
+        "formidable": "^1.2.6",
+        "inflection": "^2.0.1",
+        "proxy-addr": "^2.0.7",
+        "qs": "^6.11.0",
+        "sequelize": "^6.6.5",
+        "serve-static": "^1.15.0",
+        "slugify": "^1.6.5",
+        "type-is": "^1.6.18",
+        "vary": "^1.1.2"
+      },
+      "devDependencies": {
+        "jest": "^29.4.2"
+      },
+      "engines": {
+        "node": ">= 12.17.0"
+      }
+    },
+    "node_modules/nodester": {
+      "resolved": "../..",
+      "link": true
+    }
+  },
+  "dependencies": {
+    "nodester": {
+      "version": "file:../..",
+      "requires": {
+        "accepts": "^1.3.8",
+        "content-disposition": "^0.5.4",
+        "content-type": "^1.0.5",
+        "cookie": "^0.5.0",
+        "cookie-signature": "^1.2.0",
+        "debug": "^4.3.4",
+        "finalhandler": "^1.2.0",
+        "formidable": "^1.2.6",
+        "inflection": "^2.0.1",
+        "jest": "^29.4.2",
+        "proxy-addr": "^2.0.7",
+        "qs": "^6.11.0",
+        "sequelize": "^6.6.5",
+        "serve-static": "^1.15.0",
+        "slugify": "^1.6.5",
+        "type-is": "^1.6.18",
+        "vary": "^1.1.2"
+      }
+    }
+  }
+}

package/examples/rest/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "nodester-example-rest",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Mark Khramko",
+  "license": "MIT",
+  "dependencies": {
+  	"nodester": "file:../../"
+  }
+}

package/lib/application/MiddlewareStack.js

@@ -0,0 +1,125 @@
+const finalhandler = require('finalhandler');
+const consl = require('../logger/console');
+const debug = require('debug')('nodester:MiddlewareStack');
+
+
+module.exports = class MiddlewareStack {
+	constructor() {
+		// This array MUST stay flat!
+		this.middlewares = [];
+
+		// Indicates whether we can add more middlewares or no.
+		this.isLocked = false;
+
+
+		const env = process.env.NODE_ENV || 'development';
+		// Final middleware & error handler.
+		this.finalhandler = (req, res) => finalhandler(req, res, {
+			env: env,
+			onerror: consl.error.bind(this)
+		});
+	}
+
+
+	/**
+	 * Add the given middleware `fn` to the stack.
+	 *
+	 * @param {Function} fn
+	 * @return {Integer} index of new middleware
+	 *
+	 * @api public
+	 */
+	add(fn) {
+		if (this.isLocked) {
+			const err = new Error(`Can't add more middlewares while stack is locked.`);
+			throw err;
+		}
+
+		if (typeof fn !== 'function') {
+			const err = new TypeError('middleware must be a function!');
+			throw err;
+		}
+
+		const index = this.middlewares.push(fn);
+		debug(`added middleware (${ index })`);
+		return index;
+	}
+
+
+	/**
+	 * Removes middleware at index.
+	 *
+	 * @param {Integer} index
+	 * @return {MiddlewareStack} self
+	 *
+	 * @api public
+	 */
+	remove(index=-1) {
+		if (this.isLocked) {
+			const err = new Error(`Can't remove middlewares while stack is locked.`);
+			throw err;
+		}
+
+		if (isNaN(index)) {
+			const err = new TypeError('"index" must be an Integer!');
+			throw err;
+		}
+
+		this.middlewares.splice(middlewareIndex, 1);
+		debug(`removed middleware (${ index })`);
+		return this;
+	}
+
+
+	/*
+	 * Prepare stack for processing.
+	 *
+	 * @api public
+	 */
+	lock() {
+		// Add final handler to the stack.
+		this.add((req, res)=>this.finalhandler(req, res)());
+
+		// Stack is ready.
+		this.isLocked = true;
+
+		debug(`stack is locked`);
+	}
+
+
+	/*
+	 * Unlocks stack.
+	 *
+	 * @api public
+	 */
+	unlock() {
+		this.isLocked = false;
+		this.middlewares.pop();
+
+		debug(`stack is unlocked`);
+	}
+
+
+	/*
+	 * Start chain.
+	 *
+	 * @api public
+	 */
+	process(req, res) {
+		let middlewareOffset = -1;
+
+		const next = (...args) => {
+			middlewareOffset += 1;
+			const fn = this.middlewares[middlewareOffset];
+
+			try {
+				return fn.call(null, req, res, next, ...args);
+			}
+			catch(error) {
+				return this.finalhandler(req, res)(error);
+			}
+		}
+
+		return next();
+	}
+}