jxp 3.0.0 → 4.1.0

package/.eslintrc.json

@@ -1,20 +0,0 @@
-{
-    "env": {
-        "browser": true,
-        "commonjs": true,
-        "es6": true,
-        "node": true
-    },
-    "extends": "eslint:recommended",
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
-    },
-    "parserOptions": {
-        "sourceType": "module",
-        "ecmaVersion": 2018
-    },
-    "rules": {
-        "no-console": "off"
-    }
-}

package/.jshintrc

@@ -1,4 +0,0 @@
-{
-	"node": true,
-	"esversion": 6
-}

package/.vscode/launch.json

@@ -1,34 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Launch Program",
-            "program": "${workspaceFolder}/bin/server.js"
-        },
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Mocha Tests",
-            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
-            "args": [
-                "-u",
-                "tdd",
-                "--timeout",
-                "30000",
-                "--colors",
-                "--exit",
-                "--bail",
-                "${workspaceFolder}/test"
-            ],
-            "internalConsoleOptions": "openOnSessionStart",
-            "env": {
-                "NODE_ENV": "test"
-            }
-        }
-    ]
-}

package/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-    "restructuredtext.confPath": "${workspaceFolder}/docs"
-}

package/Dockerfile

@@ -1,7 +0,0 @@
-FROM node:17
-
-WORKDIR /jxp
-COPY package.json .
-RUN yarn install
-COPY . .
-CMD npm start

package/bin/init_db.js

@@ -1,54 +0,0 @@
-#! /usr/bin/env node
-var program = require("commander");
-var readline = require('readline-sync');
-var mongoose = require("mongoose");
-var security = require("../libs/security");
-var User = require("../models/user_model");
-
-var pkg = require('../package.json');
-
-var version = pkg.version;
-
-program
-.version(version)
-.usage('[options] [dir]')
-.option('-v, --version', 'JXP version')
-.option("-c, --config <config.js>", "Use config file")
-.option("-e, --email <user>", "Admin user email")
-.option("-p, --password <password>", "Admin password")
-.option("-u, --username <name>", "Admin user name")
-.parse(process.argv);
-
-function main() {
-	var config = require("config");
-	var email = program.email || readline.question("Admin user email: ");
-	var password = program.password || readline.question("Admin user password: ");
-	var name = program.username || readline.question("Admin user name (Admin): ", { defaultInput: "Admin" });
-	config.mongo = config.mongo || { server: "localhost", db: "jxp" };
-	//DB connection
-	mongoose.connect('mongodb://' + config.mongo.server + '/' + config.mongo.db, function(err) {
-		if (err) {
-			console.log("Database connection error", err);
-		}
-	}, {
-		db: {
-			safe:true
-		},
-	}); // connect to our database
-	var user = new User();
-	user.email = email;
-	user.password = security.encPassword(password);
-	user.name = name;
-	user.admin = true;
-	user.save((err) => {
-		if (err) {
-			console.log("Error:", err.message);
-			return process.exit(1);
-		} else {
-			console.log("Created admin user", name, "<" + email + ">");
-			return process.exit(0);
-		}
-	});
-}
-
-main();

package/bin/server.js

@@ -1,131 +0,0 @@
-/*
-=================
-JXP - Express API
-=================
-
-Documentation:
-https://jxp.readthedocs.io/en/latest/
-
-*/
-
-const mongoose = require("mongoose");
-const JXP = require("../libs/jxp");
-const config = require("config");
-require("dotenv").config();
-const pkg = require("../package.json");
-
-config.callbacks = {
-	// Examples:
-	// post: function(modelname, item, user) {
-	// 	console.log("Post callback");
-	// },
-	// put: function(modelname, item, user) {
-	// 	console.log("Put callback");
-	// },
-	// delete: function(modelname, item, user, opts) {
-	// 	console.log("Delete callback");
-	// }
-
-	post: function () { },
-	put: function () { },
-	delete: function () { }
-};
-
-config.pre_hooks = {
-	login: (req, res, next) => {
-		next();
-	},
-	get: (req, res, next) => {
-		next();
-	},
-	getOne: (req, res, next) => {
-		next();
-	},
-	post: (req, res, next) => {
-		next();
-	},
-	put: (req, res, next) => {
-		next();
-	},
-	delete: (req, res, next) => {
-		next();
-	},
-};
-
-// ES6 promises
-mongoose.Promise = Promise;
-if (!config.mongo) config.mongo = {};
-if (!config.mongo.options) config.mongo.options = {};
-const mongo_options = Object.assign(config.mongo.options, {
-	useNewUrlParser: true,
-	useUnifiedTopology: true,
-	serverSelectionTimeoutMS: 10000,
-	socketTimeoutMS: 45000,
-	maxPoolSize: process.env.NODE_ENV === 'test' ? 20 : 50,
-	minPoolSize: process.env.NODE_ENV === 'test' ? 5 : 10,
-	maxIdleTimeMS: 30000,
-	connectTimeoutMS: 10000,
-	heartbeatFrequencyMS: 10000,
-	retryWrites: true,
-	retryReads: true
-});
-
-const connection_string = require("../libs/connection_string");
-console.log(`Connecting to ${connection_string}`);
-mongoose.connect(connection_string, mongo_options);
-
-const db = mongoose.connection;
-
-// mongodb error
-db.on('error', (err) => {
-	console.error('MongoDB connection error:', err);
-	if (err.name === 'MongoNetworkError') {
-		// Handle network errors
-		console.error('Network error occurred. Attempting to reconnect...');
-	}
-});
-
-// mongodb connection open
-db.once('open', () => {
-	console.log(`Connected to Mongo at: ${new Date()}`);
-	console.log('Connection pool size:', mongoose.connection.base.connections.length);
-});
-
-mongoose.connection.on('connected', () => {
-	console.log('Mongoose connected');
-	console.log('Connection pool size:', mongoose.connection.base.connections.length);
-});
-
-mongoose.connection.on('disconnected', () => {
-	console.log('Mongoose disconnected');
-	// Attempt to reconnect after a delay
-	setTimeout(() => {
-		mongoose.connect(connection_string, mongo_options).catch(err => {
-			console.error('Failed to reconnect to MongoDB:', err);
-		});
-	}, 5000);
-});
-
-mongoose.connection.on('error', (err) => {
-	console.error('Mongoose connection error:', err);
-});
-
-// Monitor connection pool
-setInterval(() => {
-	const poolSize = mongoose.connection.base.connections.length;
-	const maxPoolSize = mongo_options.maxPoolSize;
-	if (poolSize > maxPoolSize * 0.8) {
-		console.warn(`Connection pool is at ${Math.round((poolSize / maxPoolSize) * 100)}% capacity`);
-	}
-}, 30000);
-
-var server = new JXP(config);
-
-let port = process.env.NODE_DOCKER_PORT || process.env.PORT || config.port || 4001;
-if (process.env.NODE_ENV === "test") port = 4005;
-server.listen(port, function () {
-	console.log('%s listening at %s', `${pkg.name} v${pkg.version}`, server.url);
-	console.log(`Mongoose version ${mongoose.version}`);
-});
-
-module.exports = server; // For testing

package/bin/setup.js

@@ -1,190 +0,0 @@
-#! /usr/bin/env node
-const mkdirp = require("mkdirp");
-const program = require("commander");
-const path = require("path");
-const readline = require('readline-sync');
-const fs = require("fs");
-const crypto = require("crypto");
-const execSync = require('child_process').execSync;
-const mongoose = require("mongoose");
-
-const security = require("../libs/security");
-global.JXPSchema = require("../libs/schema");
-
-const User = require("../models/user_model");
-
-const pkg = require('../package.json');
-
-const version = pkg.version;
-
-program
-	.version(version)
-	.usage('[options] [dir]')
-	.option('-v, --version', 'JXP version')
-	.parse(process.argv);
-
-async function main() {
-	try {
-		const models = ["apikey", "test", "token", "user", "usergroups", "link", "refreshtoken"];
-		const destination_path = program.args.shift() || '.';
-		// Get some defaults
-		let default_author_name = "Me";
-		let default_author_email = "me@example.com";
-		let default_app_description = "A JXP installation";
-		let default_license = "MIT";
-		let default_version = "0.0.1";
-		try {
-			default_author_name = execSync('git config --global user.name', { encoding: 'utf-8' }).trim();
-			default_author_email = execSync('git config --global user.email', { encoding: 'utf-8' }).trim();
-		} catch(err) {
-			// Nothing to see here
-		}
-		let default_app_author = `${default_author_name} <${default_author_email}>`;
-		// Ask the basics
-		let default_app_name = path.basename(path.resolve(destination_path));
-		const app_name = readline.question(`App name (${default_app_name}): `, { defaultInput: default_app_name });
-		const app_description = readline.question(`App description (${default_app_description}): `, { defaultInput: default_app_description });
-		const app_license = readline.question(`Licence (${default_license}): `, { defaultInput: default_license });
-		const app_author = readline.question(`Author (${default_app_author}): `, { defaultInput: default_app_author });
-		const app_version = readline.question(`Version (${default_version}): `, { defaultInput: default_version });
-		var opts = {};
-		// Config setup
-		// opts.email = readline.question("Admin email address: ");
-		// opts.password = readline.question("Admin password: ", { hideEchoBack: true });
-		opts.port = readline.question("Port (2001): ", { defaultInput: "2001" });
-		opts.url = readline.question("URL (http://localhost:" + opts.port + "): ", { defaultInput: "http://localhost:" + opts.port });
-		const default_connection_string = `mongodb://localhost/${ app_name }?retryWrites=true&w=majority`;
-		opts.connection_string = readline.question(`Mongo connection string (${default_connection_string}): `, { defaultInput: default_connection_string });
-		const email = readline.question(`Admin user email (${default_author_email}): `);
-		const name = readline.question(`Admin user name (${default_author_name}): `, { defaultInput: "Admin" });
-		const random_password = crypto.randomBytes(12).toString('base64');
-		const password = readline.question(`Admin user password (${random_password}): `, { hideEchoBack: true, defaultInput: random_password });
-		opts.shared_secret = crypto.randomBytes(20).toString('hex');
-		const package_data = {
-			"name": app_name,
-			"version": app_version,
-			"description": app_description,
-			"main": "bin/server.js",
-			"scripts": {
-				"test": "echo \"Error: no test specified\" && exit 1",
-				"start": "node bin/server.js"
-			},
-			"dependencies": {
-				"jxp": "^2.12.3"
-			},
-			"author": app_author,
-			"license": app_license
-		};
-		await mkdirp(destination_path); // Ensure the dir exists
-		write(path.join(destination_path, "package.json"), JSON.stringify(package_data, null, "\t"));
-		await mkdir(path.join(destination_path, "bin"));
-		await mkdir(path.join(destination_path, "models"));
-		await mkdir(path.join(destination_path, "config"));
-		await mkdir(path.join(destination_path, "logs"));
-		await mkdir(path.join(destination_path, "libs"));
-		await cp_replace("../config_sample.json", path.join(destination_path, "config/default.json"), opts, "{", "}");
-		await cp_replace("./server.js", path.join(destination_path, "bin/server.js"), { "../libs/jxp": "jxp/libs/jxp", "../libs/connection_string": "jxp/libs/connection_string" });
-		for (let model of models) {
-			await cp("../models/" + model + "_model.js", path.join(destination_path, "models/" + model + "_model.js"));
-		}
-
-		console.log();
-		console.log("Installing dependencies...")
-		console.log();
-
-		execSync(`cd ${destination_path} && npm install`);
-		
-		console.log();
-		console.log("Setting up your admin user...")
-		console.log();
-		
-		try {
-			mongoose.connect(opts.connection_string, function (err) {
-				if (err) {
-					throw(err);
-				}
-				
-			}, {
-				db: {
-					safe: true
-				},
-			});
-		} catch(err) {
-			console.log("WARNING: We had a problem talking to the database")
-			console.error(err);
-			return process.exit(1);
-		}
-		var user = new User();
-		user.email = email;
-		user.password = security.encPassword(password);
-		user.name = name;
-		user.admin = true;
-		user.save((err) => {
-			if (err) {
-				console.log("Error saving user");
-				console.error(err.message);
-				return process.exit(1);
-			} else {
-				console.log("Created admin user", name, "<" + email + ">");
-			}
-		});
-		process.chdir(destination_path);
-		console.log("Congratulations! Your JXP server is ready to go. Happy API'ing...");
-		console.log("Next steps:");
-		console.log("0. Change to your directory");
-		console.log(`     cd ${ destination_path }`);
-		console.log("1. Start your server");
-		console.log("     npm start");
-		console.log("2. Connect to your server");
-		console.log(`     ${opts.url}`);
-		return process.exit(0);
-	} catch(err) {
-		console.log("Error:", err.message);
-		return process.exit(1);
-	}
-}
-
-/**
- * Copy from to replacing text as we go
- *
- */
-function cp_replace(from, to, opts, startEnclosure = "", endEnclosure = "") {
-	startEnclosure = startEnclosure || "";
-	endEnclosure = endEnclosure || "";
-	from = path.join(__dirname, from);
-	var s = fs.readFileSync(from, "utf-8");
-	for(var i in opts) {
-		console.log(startEnclosure + i + endEnclosure, opts[i]);
-		s = s.replace(startEnclosure + i + endEnclosure, opts[i]);
-	}
-	write(to, s);
-}
-
- /**
-  * Copy from to
-  *
-  * @param {String} from
-  * @param {String} to
-  */
-function cp(from, to) {
-	from = path.join(__dirname, from);
-	write(to, fs.readFileSync(from, 'utf-8'));
-}
-
-function write(path, str, mode) {
-	fs.writeFileSync(path, str, { mode });
-	console.log('   \x1b[36mcreate\x1b[0m : ' + path);
-}
-
-/**
- * Mkdir -p.
- *
- * @param {String} path
- * @return {Promise}
- */
-
-function mkdir(path) {
-	return mkdirp(path, 0o755);
-}
-
-main();

package/config_sample.json

@@ -1,10 +0,0 @@
-{
-	"port": {port},
-	"mongo" : {
-		"connection_string": "{connection_string}",
-		"options": {}
-	},
-	"token_expiry": 86400,
-	"refresh_token_expiry": 2678400,
-	"shared_secret": "{shared_secret}"
-}

package/docker-compose.yml

@@ -1,32 +0,0 @@
-version: "3.9"
-
-services:
-  mongodb:
-    image: mongo
-    restart: always
-    environment:
-      MONGO_INITDB_ROOT_USERNAME: root
-      MONGO_INITDB_ROOT_PASSWORD: password
-    ports:
-      - $MONGODB_LOCAL_PORT:$MONGODB_DOCKER_PORT
-    volumes:
-      - db:/data/db
-
-  jxp:
-    depends_on:
-      - mongodb
-    build: ./
-    restart: unless-stopped
-    env_file: ./.env
-    ports:
-      - $NODE_LOCAL_PORT:$NODE_DOCKER_PORT
-    environment:
-      - DB_HOST=mongodb
-      - DB_USER=$MONGODB_USER
-      - DB_PASSWORD=$MONGODB_PASSWORD
-      - DB_NAME=$MONGODB_DATABASE
-      - DB_PORT=$MONGODB_DOCKER_PORT
-    stdin_open: true
-    tty: true
-volumes:
-  db:

package/libs/cache.js

@@ -1,92 +0,0 @@
-const NodeCache = require('node-cache');
-let cache;
-
-const init = (config) => {
-    if (!config.cache || !config.cache.enabled) return;
-    cache = new NodeCache({ stdTTL: config.cache.ttl || 5 * 60 });
-    if (config.cache.debug) {
-        cache.on('expired', (key) => {
-            console.log('cache expired', key)
-        })
-        cache.on('flush', () => {
-            console.log('cache flush')
-        })
-    }
-}
-
-const generateKey = (req, res) => {
-    if (res.jxp_cache_key) return res.jxp_cache_key;
-    let key = `${req.modelname}/`;
-    if (req.params.item_id) {
-        key += `${req.params.item_id}`
-    }
-    if (req.query) {
-        key += `?${JSON.stringify(req.query)}`
-    }
-    res.jxp_cache_key = key;
-    return key;
-}
-
-const set = async (req, res) => {
-    if (!cache) return;
-    const key = generateKey(req, res)
-    cache.set(key, res.result)
-    if (!req.config.cache.debug) {
-        console.log('cache set', key)
-    }
-}
-
-const get = (req, res, next) => {
-    if (!cache) return next();
-    const key = generateKey(req, res)
-    res.header('jxp-cache-key', key);
-    const cached = cache.get(key)
-    if (cached) {
-        if (!req.config.cache.debug) {
-            console.log('cache hit', key)
-        }
-        res.header('jxp-cache', 'hit')
-        res.result = cached
-        res.send(res.result);
-        return;
-    }
-    if (!req.config.cache.debug) {
-        console.log('cache miss', key)
-    }
-    res.header('jxp-cache', 'miss')
-    next()
-}
-
-const clear = async (req) => {
-    if (!cache) return;
-    const keys = cache.keys()
-    keys.forEach(key => {
-        if (key.startsWith(`${req.modelname}/`)) {
-            if (!req.config.cache.debug) {
-                console.log('cache del', key)
-            }
-            cache.del(key)
-        }
-    })
-}
-
-const clearAll = async () => {
-    cache.flushAll()
-}
-
-const stats = async (req, res) => {
-    if (!cache) {
-        res.result = { cache_enabled: false }
-        return;
-    }
-    res.result = cache.getStats()
-}
-
-module.exports = {
-    init,
-    set,
-    get,
-    clear,
-    clearAll,
-    stats,
-}

package/libs/connection_string.js

@@ -1,24 +0,0 @@
-const config = require("config");
-require("dotenv").config();
-
-// mongodb connection
-const {
-	MONGODB_USER,
-	MONGODB_PASSWORD,
-	MONGODB_HOST,
-	MONGODB_PORT,
-	MONGODB_NAME,
-	MONGODB_AUTH_DB,
-} = process.env;
-
-// mongodb connection
-let connection_string = `mongodb://localhost:27017/jxp`;
-if (config.mongo && config.mongo.connection_string) {
-	connection_string = config.mongo.connection_string;
-	console.warn("`config` to be deprecated in favour of dotenv in future versions");
-}
-if (MONGODB_HOST) {
-	connection_string = `mongodb://${ (MONGODB_USER && MONGODB_PASSWORD) ? `${MONGODB_USER}:${MONGODB_PASSWORD}@` : '' }${MONGODB_HOST}:${MONGODB_PORT}/${MONGODB_NAME}?${ (MONGODB_AUTH_DB) ? `authSource=${MONGODB_AUTH_DB}` : '' }`
-}
-
-module.exports = connection_string;