nodester 0.0.5 → 0.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodester",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "A boilerplate framework for Node.js",
   "exports": {
     ".": "./lib/application/index.js",
@@ -10,6 +10,7 @@
     "./factories/errors": "./lib/factories/errors/index.js",
     "./factories/responses/rest": "./lib/factories/responses/rest/index.js",
     "./http/codes": "./lib/http/codes/index.js",
+    "./models/define": "./lib/models/define",
     "./params": "./lib/params/Params.js",
     "./ql/sequelize": "./lib/middlewares/ql/sequelize",
     "./route": "./lib/router/route.js",

package/docs/App.md

@@ -1,13 +0,0 @@
-# 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/GoalController.js

@@ -1,62 +0,0 @@
-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/Queries.md

@@ -1,61 +0,0 @@
-# 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

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

package/docs/Routing.md

@@ -1,34 +0,0 @@
-# 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/docs/request-examples.js

@@ -1,184 +0,0 @@
-/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/goal/index.js

@@ -1,23 +0,0 @@
-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/controllers/orders.controller.js

@@ -1,15 +0,0 @@
-
-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,45 +0,0 @@
-'use strict'
-
-const nodester = require('nodester');
-const router = require('./router');
-
-// Init.
-const app = new nodester();
-
-// app.setDatabase();
-// app.set('database');
-
-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('Last!');
-
-// 	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

@@ -1,42 +0,0 @@
-{
-  "name": "nodester-example-rest",
-  "version": "1.0.0",
-  "lockfileVersion": 2,
-  "requires": true,
-  "packages": {
-    "../..": {
-      "version": "0.0.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",
-        "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",
-        "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.json

@@ -1,14 +0,0 @@
-{
-  "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/examples/rest/preprocessors/queries/orders.queries.js

@@ -1,15 +0,0 @@
-
-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

@@ -1,23 +0,0 @@
-'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);
-}