nodester 0.0.1 → 0.0.5

package/Readme.md

@@ -1,10 +1,12 @@
 # nodester
->  A robust boilerplate framework that makes iterative development easy.
+>  A robust and flexible boilerplate framework that makes iterative development easy.
 
 ## Table of Contents
 
 - [Usage](#usage)
-- [Extending](#extending-application-functionality)
+- [Markers](#markers)
+- [Router](#router)
+- [Extending App](#extending-application-functionality)
 - [Philosophy](#philosophy)
 - [License](#license)
 - [Copyright](#copyright)
@@ -19,36 +21,69 @@ const app = new nodester();
 app.set.database(db);
 
 app.listen(8080, function() {
-	console.log('listening on port', app.port);
+  console.log('listening on port', app.port);
 });
 ```
 
 ## Markers
 
-Marker is a functional condition that returns `true | false`, based on data in request.
+Marker is a functional condition that returns `true | false`, based on data in request/response.
 
+Markers are more powerful indicators than simple route definitions as any parameter in request/response can be used.
 
-### Adding a Marker
+For example: our application has 2 domains:
+`admin.awesomeapp.com`
+`api.awesomeapp.com`
+
+You add markers and handlers specifically for those domains:
 
 ```js
-app.add.marker('admin', (req) => req.role === 'admin');
+app.add.marker('ADMIN', (req) => req.hostname === 'admin.awesomeapp.com');
+app.add.marker('API', (req) => req.hostname === 'api.awesomeapp.com');
 ```
 
-
-### Using a Marker
+And then use them:
 
 ```js
-app.only('admin').route('get /payments', <handler>);
-app.only('/api').route('get /payments', <handler>);
+app.only('ADMIN').route('get /payments', <handler/>);
+app.only('API').route('get /payments', <handler/>);
+// Or:
+app.only('ADMIN').use(<handler/>);
+app.only('API').use(<handler/>);
 ```
 
+The same can be done for any parameter in request/response:
+
+```js
+app.add.marker('admin_role', (req) => req.role === 'admin');
+app.only('admin_role').route('get /secrets', <handler/>);
+app.only('admin_role').use(<handler/>);
+```
 
 ## Router
 
+Router is a built-in middleware.
+
+```js
+const Router = require('nodester/router');
+
+const controllersPath = <path_to_controllers_directory/>;
+const router = new Router({ controllersPath });
+
+router.add.route('get /books', function(req, res) { ... } );
+// Or:
+router.add.route('get /books', { controlledBy: 'BooksController.getMany' } );
+router.add.route('get /books/:id', { controlledBy: 'BooksController.getOne' } );
+```
+
+### Using Router:
+
 ```js
-app.route('get /books', function(req, res) { ... } );
-app.route('get /books', { controlledBy: 'BooksController.getMany' } );
-app.route('get /books/:id', { controlledBy: 'BooksController.getOne' } );
+const nodester = require('nodester');
+const router = require(<path_to_router_definition/>);
+
+const app = new nodester();
+app.use(router());
 ```
 
 
@@ -62,9 +97,9 @@ const serveStatic = require('serve-static');
 
 const nodester = require('nodester');
 
-const app = nodester();
+const app = new nodester();
 app.extend('static', serveStatic);
-app.static(<path_to_static_directory>);
+app.static(<path_to_static_directory/>);
 ```
 
 Short:
@@ -73,8 +108,8 @@ const serveStatic = require('serve-static');
 
 const nodester = require('nodester');
 
-const app = nodester();
-app.extend('static', serveStatic)(<path_to_static_directory>);
+const app = new nodester();
+app.extend('static', serveStatic)(<path_to_static_directory/>);
 ```
 
 Of course you might just do this:
@@ -83,7 +118,7 @@ const serveStatic = require('serve-static');
 
 const nodester = require('nodester');
 
-const app = nodester();
+const app = new nodester();
 app.static = serveStatic;
 ````
 But you'll never know if you did override any of the app's properties or did not.
@@ -91,17 +126,17 @@ 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:
+If you really want to override properties or use `nodester` as a boilerplate, you should extend default Application class:
 
 ```js
-const DefaultApplication = require('nodester');
+const NodesterApp = require('nodester');
 
-class MyApp extends DefaultApplication {
-	constructor(opts) {
-		super(opts)
-	}
+class MyApp extends NodesterApp {
+  constructor(opts) {
+    super(opts)
+  }
 
-	// Override everything you want here...
+  // Override everything you want here...
 }
 
 // Don't forget to expose.
@@ -114,7 +149,7 @@ The Philosophy of `nodester` is to provide a developer with a tool that can buil
 
 ### Goal
 
-The goal of `nodester` is to be a robust boilerplate that makes iterative development easy.
+The goal of `nodester` is to be a robust and flexible framework that makes iterative development easy.
 
 
 ## LICENSE

package/docs/GoalController.js

@@ -0,0 +1,62 @@
+const {
+	withDefaultCRUD
+} = require('nodester/controllers/mixins');
+const {
+	getOne,
+	getMany,
+	createOne,
+	updateOne,
+	deleteOne
+} = require('nodester/controllers/methods');
+
+
+#nodester
+function withDefaultCRUD(instance, opts={}) {}
+function getOne(req, res) {}
+function getMany(req, res) {}
+function createOne(req, res) {}
+
+const with = (fn1, fn2) => {
+	const caller = this;
+
+	// If Async:
+	if (fn1.constructor.name === 'AsyncFunction')
+		return async (req, res) => {
+			await fn1.call(caller, req, res);
+			return fn2.call(caller, req, res);
+		}
+
+	// If Sync:
+	return (req, res) => {
+		fn1.call(caller, req, res);
+		return fn2.call(caller, req, res);
+	}	
+};
+
+// Basic example
+module.exports = function OrdersController() {
+	withDefaultCRUD(this, {
+		model: Order,
+	});
+}
+
+// Configurable
+module.exports = function OrdersController() {
+	withDefaultCRUD(this, {
+		model: Order,
+		// Optional:
+		name: 'OrdersController',
+		only: [
+			'getOne',
+			'getMany'
+		]
+	});
+};
+
+// Or:
+module.exports = function OrdersController() {
+	this.model = Order;
+
+	this.getOne = with(queryPreprocessor, getOne);
+};
+

package/docs/request-examples.js

@@ -0,0 +1,184 @@
+/posts?in=comments,comments.author,comments.likes.user
+/posts?in=comments(in=author,likes.user)
+
+/posts?id=100.0&in=comments(in=author.avatar&order=desc).user,likes&order_by=comments.id
+/posts?id=not(100.0)&&order_by=comments.id
+
+/orders?position=1&status=PUBLISHED&in=products(limit=20)
+{
+	model: "orders",
+	where: {
+		and: [
+			{
+				status: ["PUBLISHED"]
+			},
+			{
+				position: [1]
+			}
+		]
+	},
+	includes: [
+		{
+			model: "products",
+			limit: 20,
+			skip: 0
+		}
+	],
+	limit: -1,
+	skip: 0
+}
+
+
+/orders?in=user(vk_user_id=like(john))&skip=10
+
+{
+	model: "orders",
+	includes: [
+		{
+			model: "user",
+			where: {
+				vk_user_id: {
+					like: "john"
+				}
+			},
+			limit: -1,
+			skip: 0
+		}
+	],
+	limit: -1,
+	skip: 10
+}
+
+/orders?in=user&or(user.vk_user_id=like(),user.name=like())
+
+{
+	model: "orders",
+	where: {
+		or: {
+			user.vk_user_id: like(),
+			user.name: like()
+		}
+	}
+}
+
+/orders?id=10
+
+param: id,
+value: {
+	token: 10,
+	value: 10
+}
+
+{
+	model: orders,
+	where: {
+		id: [10]
+	},
+	skip: -1,
+	limit: 0
+}
+
+/orders?id=[10,20]
+
+param: id,
+value: {
+	token: in,
+	value: [10,20]
+}
+
+/orders?id=or(10,100)
+
+param: id,
+value: {
+	token: or,
+	value: [10,100)
+}
+
+/orders?id=!(10,100)
+
+param: id,
+value: {
+	token: not,
+	value: [10,100)
+}
+
+
+/orders?or(user.name=leo,id=100)&in=user
+
+param:
+
+
+{
+	where: {
+		param: where,
+		value: { id: 100 }
+		children: {}
+	},
+	in: {
+		param: in
+		value: null,
+		children: {
+
+		}
+	}
+}
+
+{
+	param: id
+	value: 10
+	parent: root
+	children: {}
+}
+
+
+
+/posts?id=100.0&in=comments(in=author.avatar&order=desc).user.followers(id=gt(10)&limit=1),likes&order_by=comments.id
+
+{
+	model: 'root',
+	where: {
+		id: [100.0]
+	},
+	includes: [
+		{
+			model: 'comments',
+			where: {},
+			includes: [
+				{
+					model: 'author',
+					where: {},
+					includes: [
+						{
+							model: 'avatar',
+							limit: -1,
+							skip: 0
+						}
+					],
+					limit: -1,
+					skip: 0
+				},
+				{
+					model: 'user',
+					includes: [
+						{
+							model: 'followers',
+							where: {
+								id: {
+									'gt': [10]
+								}
+							},
+							limit: 1,
+							skip: 0
+						}
+					],
+					limit: -1,
+					skip: 0
+				}
+			],
+			order: 'desc'
+		}
+	],
+	limit: -1,
+	skip: 0,
+	order_by: 'comments.id'
+}

package/examples/rest/controllers/orders.controller.js

@@ -0,0 +1,15 @@
+
+function OrdersController() {
+
+	this.getMany = function(req, res) {
+		console.log({ query: req.query });
+		res.json({ controller: 'OrdersController', method: 'getMany' });
+	}
+
+	this.getOne = function(req, res) {
+		const { params } = req;
+		res.json({ controller: 'OrdersController', method: 'getOne', params });
+	}
+}
+
+module.exports = new OrdersController();

package/examples/rest/index.js

@@ -1,20 +1,40 @@
-const Nodester = require('nodester');
+'use strict'
+
+const nodester = require('nodester');
+const router = require('./router');
 
 // Init.
-const app = new Nodester();
+const app = new nodester();
 
 // app.setDatabase();
 // app.set('database');
 
-// app.add('marker', 'GET_M', (req)=>req.method === 'GET');
+app.use(router());
+
+// app.add.marker('GET_M', (req)=>req.method === 'GET');
+
+// app.only('GET_M').use(async (req, res) => {
+// 	res.json(req.nquery);
+// });
+
+// app.use((req, res)=>res.json({ msg: 'last' }));
+
+// app.only('GET_M').route('get /orders', async (req, res) => {
+// 	res.json({ route: 'orders' });
+// });
+
+// app.add.middleware((req, res, next)=>{
+// 	console.log('1st', 'hello!');
+// 	next();
+// });
 
-app.add.middleware((req, res, next)=>{
-	console.log('1st');
+// app.add.middleware((req, res, next)=>{
+// 	console.log('Last!');
 
-	res.setHeader("Content-type", "text/html");
-	res.write("Hello!<br/>...my friend");
-	res.end();
-})
+// 	res.setHeader("Content-type", "text/html");
+// 	res.write("Hello!<br/>...my friend");
+// 	res.end();
+// });
 
 app.beforeStart(()=>{
 	console.log('Before start passed!');

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

@@ -5,7 +5,7 @@
   "requires": true,
   "packages": {
     "../..": {
-      "version": "0.6.1",
+      "version": "0.0.1",
       "license": "MIT",
       "dependencies": {
         "accepts": "^1.3.8",
@@ -16,12 +16,14 @@
         "debug": "^4.3.4",
         "finalhandler": "^1.2.0",
         "formidable": "^1.2.6",
+        "fresh": "^0.5.2",
+        "http-errors": "^2.0.0",
         "inflection": "^2.0.1",
         "proxy-addr": "^2.0.7",
         "qs": "^6.11.0",
+        "range-parser": "^1.2.1",
+        "send": "^0.18.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/preprocessors/queries/orders.queries.js

@@ -0,0 +1,15 @@
+
+module.exports = function OrdersQueryPreprocessor(opts={}) {
+	return handle.bind(this);
+}
+
+async function handle(nquery, req, res) {
+	console.log("was called", { nquery });
+
+	// Get role or set "visitor".
+	// const _role = typeof role === 'string' && role.length > 1 ? role : VISITOR;
+
+	// const policy = this.policies[_role];
+
+	// const resultQuery = await traverse(nquery, policy, this.model);
+}

package/examples/rest/router.js

@@ -0,0 +1,23 @@
+'use strict'
+
+const Router = require('nodester/router');
+// Preprocessors:
+const preprocessOrdersQuery = require('./preprocessors/queries/orders.queries');
+// Utils.
+const Path = require('path');
+
+
+module.exports = function initRouter() {
+	const controllersPath = Path.join(__dirname, 'controllers');
+	const router = new Router({ controllersPath });
+
+	// router.add.route('get /orders', async (req, res) => {
+	// 	res.json({ route: 'orders' });
+	// });
+
+	router.add.route('get /orders', { before: preprocessOrdersQuery(), controlledBy: 'orders.getMany' });
+	router.add.route('get /orders/*', { controlledBy: 'orders.getMany' });
+	router.add.route('get /orders/:id', { controlledBy: 'orders.getOne' });
+
+	return router.handle.bind(router);
+}