nodester 0.6.5 → 0.6.7

package/Readme.md

@@ -1,7 +1,11 @@
-# nodester
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/MarkKhramko/nodester/refs/heads/main/.github/assets/nodester_logo.png">
+    <img alt="nodester logo" src="https://raw.githubusercontent.com/MarkKhramko/nodester/refs/heads/main/.github/assets/nodester_logo.png">
+  </picture>
+</div>
 
-[![NPM version](https://img.shields.io/npm/v/nodester)](https://www.npmjs.com/package/nodester)
-[![License](https://img.shields.io/npm/l/nodester)](https://www.npmjs.com/package/nodester)
+# nodester [![NPM version](https://img.shields.io/npm/v/nodester)](https://www.npmjs.com/package/nodester) [![License](https://img.shields.io/npm/l/nodester)](https://www.npmjs.com/package/nodester)
 
 > **nodester** is a Node.js framework designed to solve the problem of a complex data querying over HTTP.
 
@@ -39,10 +43,14 @@ const db = require('#db');
 const app = new nodester();
 app.set.database(db);
 
+// Do any synchronous initializations
+// before app.listen here
+// ...
+
 // Optional beforeStart hook:
 app.beforeStart(async () => {
   // Do any asynchronous initializations
-  // before app.listen
+  // before app.listen here
   // ...
 });
 

package/lib/application/index.js

@@ -6,7 +6,7 @@
 'use strict';
 
 const Emitter = require('events');
-const NodesterRouter = require('../router');
+const NodesterRouter = require('nodester/router');
 
 // Server:
 const http = require('http');

package/lib/constants/Bounds.js

@@ -1,3 +1,10 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
 const Enum = require('nodester/enum');
 
 const limit = {

package/lib/constants/Clauses.js

@@ -1,3 +1,10 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
 const Enum = require('nodester/enum');
 
 const LIMIT = 'limit';

package/lib/constants/ErrorCodes.js

@@ -1,3 +1,10 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
 const Enum = require('nodester/enum');
 
 const NODESTER_QUERY_ERROR = 'NodesterQueryError';

package/lib/constants/FileExtensions.js

@@ -0,0 +1,44 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
+// JS:
+const jsCodeExtensions = [
+	'js', // built-in
+	'cjs', // https://nodejs.org/api/esm.html#esm_enabling
+	'mjs', // https://nodejs.org/api/esm.html#esm_enabling
+	'iced', // http://maxtaco.github.io/coffee-script/
+	'liticed', // http://maxtaco.github.io/coffee-script/ (literate iced)
+	'iced.md', // http://maxtaco.github.io/coffee-script/ (literate iced)
+	'coffee', // http://coffeescript.org/
+	'litcoffee', // http://coffeescript.org/ (literate coffee)
+	'coffee.md', // http://coffeescript.org/ (literate coffee)
+	'ts', // https://www.typescriptlang.org/
+	'tsx', // https://www.typescriptlang.org/docs/handbook/jsx.html
+	'cs',  // http://bridge.net/ ??
+	'ls', // http://livescript.net/
+	'es6', // https://babeljs.io
+	'es', // https://babeljs.io
+	'jsx', // https://babeljs.io https://facebook.github.io/jsx/.
+	'sjs', // http://onilabs.com/stratifiedjs
+	'co', // http://satyr.github.io/coco/
+	'eg' // http://www.earl-grey.io/
+];
+
+const jsConfigExtensions = [
+	'json', // built-in
+	'json.ls', // http://livescript.net/
+	'json5' // http://json5.org/
+];
+// JS\
+
+
+module.exports = {
+	js: {
+		code: jsCodeExtensions,
+		config: jsConfigExtensions
+	}
+}

package/lib/constants/Operators.js

@@ -0,0 +1,30 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
+const Enum = require('nodester/enum');
+
+
+module.exports = new Enum({
+	and: Symbol.for('and'),
+	between: Symbol.for('between'),
+	contains: Symbol.for('contains'),
+	eq: Symbol.for('eq'),
+	ne: Symbol.for('ne'),
+	gte: Symbol.for('gte'),
+	gt: Symbol.for('gt'),
+	lte: Symbol.for('lte'),
+	lt: Symbol.for('lt'),
+	not: Symbol.for('not'),
+	is: Symbol.for('is'),
+	in: Symbol.for('in'),
+	notIn: Symbol.for('notIn'),
+	like: Symbol.for('like'),
+	notLike: Symbol.for('notLike'),
+	notBetween: Symbol.for('notBetween'),
+	or: Symbol.for('or'),
+	xor: Symbol.for('xor'),
+});

package/lib/constants/ResponseFormats.js

@@ -1,3 +1,10 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
 const Enum = require('nodester/enum');
 
 

package/lib/http/codes/descriptions.js

@@ -2,6 +2,7 @@
  * nodester
  * MIT Licensed
  */
+
 'use strict';
 
 const Enum = require('nodester/enum');

package/lib/http/methods/index.js

@@ -0,0 +1,29 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
+const Enum = require('nodester/enum');
+
+
+module.exports = new Enum({
+	// Core REST methods:
+	GET: 'GET',
+	POST: 'POST',
+	PUT: 'PUT',
+	PATCH: 'PATCH',
+	DELETE: 'DELETE',
+	// Additional but common in REST APIs:
+	HEAD: 'HEAD',
+	OPTIONS: 'OPTIONS',
+
+	// Search and non-standard querying:
+	SEARCH: 'SEARCH',
+	QUERY: 'QUERY',
+
+	// Rarely used in REST but valid HTTP:
+	TRACE: 'TRACE',
+	CONNECT: 'CONNECT',
+});

package/lib/middlewares/404/index.js

@@ -0,0 +1,38 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
+const {
+	HTTP_CODE_NOT_FOUND
+} = require('nodester/http/codes');
+
+const { createErrorResponse } = require('nodester/factories/responses/rest');
+
+
+/**
+ * Initialize `404` middleware.
+ *
+ * @param {Object}  [options]
+ *
+ * @return {Function}
+ *
+ * @access public
+ */
+module.exports = function init404Middleware(options={}) {
+	const context = {
+		options
+	}
+	return handle.bind(context);
+}
+
+function handle(req, res, next) {
+	const err = new Error('Route not found');
+	
+	return createErrorResponse(res, {
+		error: err,
+		status: HTTP_CODE_NOT_FOUND
+	});
+}

package/lib/middlewares/etag/index.js

@@ -0,0 +1,81 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+
+'use strict';
+
+const calculate = require('etag');
+const Stream = require('stream');
+
+// Utils:
+const promisify = require('util').promisify;
+const fs = require('fs');
+const getFileStats = promisify(fs.stat);
+
+
+module.exports = initETagMiddleware;
+
+/**
+ * Initialize `etag` middleware.
+ *
+ * @param {Object}  [options]
+ * @param {boolean} options.weak
+ *
+ * @return {Function}
+ *
+ * @access public
+ */
+function initETagMiddleware(options) {
+	const context = {
+		options
+	}
+	return handle.bind(context);
+}
+
+/**
+ * Add ETag header field.
+ */
+function handle(req, res, next) {
+	// console.log('e', req.headers);
+	return next();
+}
+
+async function _getResponseEntity(res) {
+	// If body is not defined:
+	const { body } = res;
+	if (!body || res.get('etag'))
+		return;
+
+	// Status code.
+	const status = res.statusCode / 100 | 0;
+
+	console.log('getResponseEntity', status, { tag: res.get('etag') });
+
+	// 2xx
+	if (status !== 2)
+		return;
+
+	if (body instanceof Stream) {
+		if (!body.path)
+			return;
+
+		const stats = await getFileStats(body.path);
+		return stats;
+	}
+	else if (typeof body === 'string' || Buffer.isBuffer(body)) {
+		return body;
+	}
+	else {
+		return JSON.stringify(body);
+	}
+}
+
+function _setEtag(res, entity, options) {
+	console.log('setEtag', typeof res, entity);
+
+	if (!entity)
+		return;
+
+	res.etag = calculate(entity, options);
+}

package/lib/middlewares/render/index.js

@@ -0,0 +1,62 @@
+/**
+ * nodester
+ * MIT Licensed
+ */
+ 
+'use strict';
+
+
+module.exports = function initRenderMiddleware() {
+	return handle;
+}
+
+
+function handle(req, res, next) {
+	const context = { req, res, next };
+	res.render = _render.bind(context);
+	next();
+}
+
+
+/**
+ * Render `view` with the given `options` and optional callback `fn`.
+ * When a callback function is given a response will _not_ be made
+ * automatically, otherwise a response of _200_ and _text/html_ is given.
+ *
+ * Options:
+ *
+ *  - `cache`     boolean hinting to the engine it should cache
+ *  - `filename`  filename of the view being rendered
+ *
+ * @alias render
+ * @access public
+ */
+function _render(view, options, callback) {
+	const app = this.req.app;
+	let done = callback;
+	let opts = options || {};
+	
+	const req = this.req;
+	const res = this.res;
+	const next = this.next;
+
+	// support callback function as second arg
+	if (typeof options === 'function') {
+		done = options;
+		opts = {};
+	}
+
+	// merge res.locals
+	opts._locals = res.locals;
+
+	// default callback to respond
+	done = done || function (err, str) {
+		if (err)
+			return next(err);
+		
+		res.send(str);
+	};
+
+	// render
+	app.render(view, opts, done);
+};

package/lib/router/index.js

@@ -5,6 +5,9 @@
 
 'use strict';
 
+// Constants.
+const FileExtensions = require('nodester/constants/FileExtensions');
+
 const MiddlewaresStack = require('nodester/stacks/middlewares');
 const Route = require('./route');
 
@@ -22,7 +25,6 @@ const { parseProviderFileNames } = require('./utils');
 //	File system:
 const Path = require('path');
 const fs = require('fs');
-const commonExtensions = require('common-js-file-extensions');
 
 // Arguments validator.
 const { ensure } = require('nodester/validators/arguments');
@@ -59,7 +61,7 @@ module.exports = class NodesterRouter {
 		// Reference to the providers stack.
 		this._providers = new Map();
 
-		this.codeFileExtensions = commonExtensions.code;
+		this.codeFileExtensions = FileExtensions.js.code;
 		this.paths = {};
 
 		// Options:

package/lib/router/routes.util.js

@@ -5,6 +5,8 @@
 
 'use strict';
 
+const HTTP_METHODS = require('nodester/http/methods');
+
 const MiddlewaresStack = require('nodester/stacks/middlewares');
 
 // Utils:
@@ -20,7 +22,7 @@ module.exports = {
 
 function _validateParsedRouteMethood(parsedRoute) {
 	if (!parsedRoute || parsedRoute?.method === undefined) {
-		const err = new TypeError(`"route" should start with one of the following methods: [GET, POST, PUT, DELETE, QUERY, HEADER, OPTIONS]`);
+		const err = new TypeError(`Route definition must start with one of the following methods: ${ HTTP_METHODS.asArray.join(', ') } or any other custom one.`);
 		throw err;
 	}
 
@@ -52,7 +54,16 @@ function _wrapRouteHandler(routeInstance, handler) {
 		if (parsedHandler.controllerName !== undefined) {
 			// Get method (action) from Controller:
 			const controller = this._controllers.get(parsedHandler.controllerName);
+			if (!controller) {
+				const err = new TypeError(`Controller named "${ parsedHandler.controllerName }" is not defined.`);
+				throw err;
+			}
+
 			const controllerAction = controller[parsedHandler.actionName];
+			if (!controllerAction) {
+				const err = new TypeError(`Handler "${ parsedHandler.actionName }" is not defined in controller "${ parsedHandler.controllerName }".`);
+				throw err;
+			}
 
 			providedAction = controllerAction;
 		}
@@ -62,7 +73,16 @@ function _wrapRouteHandler(routeInstance, handler) {
 		else {
 			// Get method (action) from Provider:
 			const provider = this._providers.get(parsedHandler.providerName);
+			if (!provider) {
+				const err = new TypeError(`Provider named "${ parsedHandler.providerName }" is not defined.`);
+				throw err;
+			}
+
 			const providerAction = provider[parsedHandler.actionName];
+			if (!providerAction) {
+				const err = new TypeError(`Handler "${ parsedHandler.actionName }" is not defined in provider "${ parsedHandler.providerName }".`);
+				throw err;
+			}
 
 			providedAction = providerAction;
 		}

package/lib/router/utils.js

@@ -10,7 +10,7 @@ module.exports = {
 	parseProviderFileNames: _parseProviderFileNames
 }
 
-function _parseProviderFileNames(fileNames, availableFileExtensions, term='controller') {
+function _parseProviderFileNames(fileNames=[], availableFileExtensions=[], term='controller') {
 	const resultNames = [];
 
 	for (const fileName of fileNames) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodester",
-  "version": "0.6.5",
+  "version": "0.6.7",
   "description": "A versatile REST framework for Node.js",
   "directories": {
     "docs": "docs",
@@ -16,6 +16,7 @@
     "./body/extract": "./lib/body/extract.js",
 
     "./constants/ErrorCodes": "./lib/constants/ErrorCodes.js",
+    "./constants/FileExtensions": "./lib/constants/FileExtensions.js",
 
     "./controllers/methods": "./lib/controllers/methods/index.js",
     "./controllers/mixins": "./lib/controllers/mixins/index.js",
@@ -42,6 +43,7 @@
     "./http/codes": "./lib/http/codes/index.js",
     "./http/codes/descriptions": "./lib/http/codes/descriptions.js",
     "./http/codes/symbols": "./lib/http/codes/symbols.js",
+    "./http/methods": "./lib/http/methods/index.js",
 
     "./loggers/console": "./lib/loggers/console.js",
     "./loggers/dev": "./lib/loggers/dev.js",
@@ -78,7 +80,6 @@
   "dependencies": {
     "@js-temporal/polyfill": "^0.4.3",
     "body-parser": "^1.20.2",
-    "common-js-file-extensions": "^1.0.4",
     "cookie": "^1.0.0",
     "cookie-signature": "^1.2.0",
     "debug": "^4.3.4",
@@ -89,8 +90,8 @@
     "http-errors": "^2.0.0",
     "inflection": "^2.0.1",
     "mime": "^3.0.0",
-    "mysql2": "^3.6.0",
-    "pg": "^8.11.3",
+    "mysql2": "^3.14.4",
+    "pg": "^8.16.3",
     "pg-hstore": "^2.3.4",
     "qs": "^6.11.0",
     "sequelize": "^6.6.5"

package/tests/ast.js

@@ -0,0 +1,18 @@
+const { ModelsTree } = require('../lib/middlewares/ql/sequelize/interpreter/ModelsTree');
+const { AST_ModelsTree } = require('../lib/tools/nql.tool');
+
+const tree = new ModelsTree();
+tree.node.addWhere({ id: ['1000'] });
+tree.include('comments').use('comments');
+tree.node.order = 'desc';
+tree.up();
+tree.include('users');
+tree.include('likes') && tree.use('likes');
+tree.node.order = 'rand';
+tree.up();
+tree.include('reposts');
+
+console.debug(
+	AST_ModelsTree(tree)
+);
+

package/tests/index.test.js

@@ -9,14 +9,13 @@ const {
 // Configs.
 const PORT = 8100;
 
-// Our lib.
-const Nodester = require('../lib/application');
+const nodester = require('nodester');
 
 
 describe('nodester application', () => {
 
 	// Init.
-	const app = new Nodester();
+	const app = new nodester();
 	it('construct', () => {
 		expect(app).toBeDefined();
 	});