nodester 0.0.7 → 0.0.9

package/Readme.md

@@ -4,13 +4,13 @@
 ## Table of Contents
 
 - [Usage](#usage)
-- [Markers](#markers)
-- [Router](#router)
+- [Documentation](#documentation)
 - [Extending App](#extending-application-functionality)
 - [Philosophy](#philosophy)
 - [License](#license)
 - [Copyright](#copyright)
 
+
 ## Usage
 
 ```js
@@ -25,72 +25,17 @@ app.listen(8080, function() {
 });
 ```
 
-## Markers
-
-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.
+## Documentation
 
-For example: our application has 2 domains:
-`admin.awesomeapp.com`
-`api.awesomeapp.com`
+### Core concepts
+[Go to core concepts documentaion](docs/CoreConcepts.md)
 
-You add markers and handlers specifically for those domains:
-
-```js
-app.add.marker('ADMIN', (req) => req.hostname === 'admin.awesomeapp.com');
-app.add.marker('API', (req) => req.hostname === 'api.awesomeapp.com');
-```
 
-And then use them:
+### Extending Application functionality
 
-```js
-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
-const nodester = require('nodester');
-const router = require(<path_to_router_definition/>);
-
-const app = new nodester();
-app.use(router());
-```
-
-
-## Extending Application functionality
-
-
-### Extending instance (safe way):
+#### Extending instance (safe way):
 
 ```js
 const serveStatic = require('serve-static');
@@ -124,7 +69,7 @@ app.static = serveStatic;
 But you'll never know if you did override any of the app's properties or did not.
 
 
-### Extending class:
+#### Extending class:
 
 If you really want to override properties or use `nodester` as a boilerplate, you should extend default Application class:
 
@@ -143,6 +88,7 @@ class MyApp extends NodesterApp {
 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.

package/lib/models/associate.js

@@ -0,0 +1,17 @@
+
+module.exports = async function associateModels(databaseConnection) {
+	try {
+		const models = databaseConnection.models;
+
+		const modelNames = Object.keys(models);
+
+		for (let modelName of modelNames) {
+			await models[modelName].associate(models);
+		}
+
+		return Promise.resolve(models);
+	}
+	catch(error) {
+		return Promise.reject(error);
+	}
+}

package/lib/models/define.js

@@ -37,6 +37,7 @@ function defineModel(
 		// Add user-defined options (they can override upper ones).
 		...options
 	};
+
 	const model = databaseConnection.define(modelName, definitionObject, _options);
 
 	if (options.noCRUD !== true) {

package/lib/models/mixins.js

@@ -6,7 +6,7 @@ const {
 	modelHasAssociations,
 	getModelAssociationProps,
 	compileModelAssociationData,
-} = require('nodester/utils/modelAssociations.util');
+} = require('../utils/modelAssociations.util');
 
 
 module.exports = {
@@ -17,15 +17,15 @@ module.exports = {
 /**
  * Sets all of CRUD methods to Model.
  *
- * @param {Object} controller
+ * @param {Object} modelDefinition
  *
  *
  * @api public
  * @alias implementsCRUD
  */
-function _implementsCRUD(model) {
-	if (!model) {
-		const err = new TypeError(`'model' argument is not provided.`);
+function _implementsCRUD(modelDefinition) {
+	if (!modelDefinition) {
+		const err = new TypeError(`"modelDefinition" argument is not provided.`);
 		throw err;
 	}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodester",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "A boilerplate framework for Node.js",
   "exports": {
     ".": "./lib/application/index.js",
@@ -10,7 +10,8 @@
     "./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",
+    "./models/associate": "./lib/models/associate.js",
+    "./models/define": "./lib/models/define.js",
     "./params": "./lib/params/Params.js",
     "./ql/sequelize": "./lib/middlewares/ql/sequelize",
     "./route": "./lib/router/route.js",

package/lib/models/DisabledRefreshToken.js

@@ -1,68 +0,0 @@
-const defineModel = require('./define');
-// ORM.
-const { DataTypes } = require('sequelize');
-
-
-module.exports = _defineDisabledRefreshToken;
-
-function _defineDisabledRefreshToken(
-	database,
-	roleIds=[],
-	options={}
-) {
-
-	const fields = {
-		id: {
-			type: DataTypes.INTEGER.UNSIGNED,
-			allowNull: false,
-			primaryKey: true,
-			autoIncrement: true,
-			_autoGenerated: true
-		},
-		
-		token: {
-			type: DataTypes.STRING,
-			required: true,
-			allowNull: false,
-			unique: true
-		}
-	};
-
-	roleIds.forEach(roleId => fields[roleId] = {
-		type: DataTypes.INTEGER.UNSIGNED,
-		allowNull: true
-	});
-
-	const disabledRefreshToken = defineModel(database, 'DisabledRefreshToken',
-		(DataTypes) => ( fields ),
-		{ ...options }
-	);
-
-	disabledRefreshToken.createOrFind = function({ 
-		token,
-		...roleInfo
-	}) {
-		const where = {
-			token
-		};
-
-		const defaults = {
-			token: token,
-			...roleInfo
-		};
-
-		const query = {
-			where,
-			defaults
-		};
-		return this.findOrCreate(query);
-	}
-
-	disabledRefreshToken.selectAll = function({ token }) {
-		const where = { token };
-		const query = { where };
-		return this.findAll(query);
-	}
-
-	return disabledRefreshToken;
-}