jxp 2.16.0 → 4.0.0

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;

package/libs/datamunging.js

@@ -1,335 +0,0 @@
-var _ = require("underscore");
-
-var input1 = {
-	due_date: '2016-02-01T00:00:00Z',
-	from_document: '',
-	allow_online_payment: 'false',
-	paid: 'true',
-	locked: 'false',
-	customer_id: '2446859',
-	modified: '2016-02-02T15:09:06.983',
-	created: '2016-02-01T21:09:37.873',
-	date: '2016-02-01T00:00:00Z',
-	inclusive: 'false',
-	discount_percentage: '0',
-	tax_reference: '',
-	discount: '0',
-	amount_due: '0',
-	printed: 'false',
-	editable: 'true',
-	has_attachments: 'false',
-	has_notes: 'false',
-	has_anticipated_date: 'false',
-	'lines[0][SelectionId]': '6824935',
-	'lines[0][TaxTypeId]': '965302',
-	'lines[0][ID]': '74465675',
-	'lines[0][LineType]': '0',
-	'lines[0][Quantity]': '1',
-	'lines[0][Unit]': '',
-	'lines[0][TaxPercentage]': '0.14',
-	'lines[0][DiscountPercentage]': '0',
-	'lines[0][Discount]': '0',
-	'lines[1][ID]': '74465676',
-	'lines[1][LineType]': '0',
-	'lines[1][Quantity]': '4',
-	'lines[1][Unit]': '',
-	'lines[1][TaxPercentage]': '0.14',
-	'lines[1][DiscountPercentage]': '0',
-	'lines[1][Discount]': '0',
-	'lines[1][Comments]': '',
-	location: '547d506b184d110c0601314c',
-	id: '93490358',
-}
-
-var test1 = {
-	due_date: '2016-02-01T00:00:00Z',
-	from_document: '',
-	allow_online_payment: 'false',
-	paid: 'true',
-	locked: 'false',
-	customer_id: '2446859',
-	modified: '2016-02-02T15:09:06.983',
-	created: '2016-02-01T21:09:37.873',
-	date: '2016-02-01T00:00:00Z',
-	inclusive: 'false',
-	discount_percentage: '0',
-	tax_reference: '',
-	discount: '0',
-	amount_due: '0',
-	printed: 'false',
-	editable: 'true',
-	has_attachments: 'false',
-	has_notes: 'false',
-	has_anticipated_date: 'false',
-	lines:
-		[{
-			SelectionId: '6824935',
-			TaxTypeId: '965302',
-			ID: '74465675',
-			LineType: '0',
-			Quantity: '1',
-			Unit: '',
-			TaxPercentage: '0.14',
-			DiscountPercentage: '0',
-			Discount: '0'
-		},
-		{
-			ID: '74465676',
-			LineType: '0',
-			Quantity: '4',
-			Unit: '',
-			TaxPercentage: '0.14',
-			DiscountPercentage: '0',
-			Discount: '0',
-			Comments: ''
-		}],
-	location: '547d506b184d110c0601314c',
-	id: '93490358'
-}
-
-input2 = {
-	'test[0][Yo]': "0Yo",
-	'test[0][No]': '0No',
-	'test[1][Yo]': "1Yo",
-	'test[1][No]': '1No',
-	'test[3][No][Yo][0][Lo]': '2NoYo0Lo',
-	normalProperty: 123
-}
-
-test2 = {
-	test: [
-		{
-			Yo: "0Yo",
-			No: "0No"
-		},
-		{
-			Yo: "1Yo",
-			No: "1No"
-		},
-		{
-			No: {
-				Yo: [
-					{ Lo: "2NoYo0Lo" }
-				]
-			}
-		}
-	],
-	normalProperty: 123
-}
-
-input3 = {
-	'test[0][Yo]': "0Yo",
-	'test[0][No]': '0No',
-	'test[1][Yo]': "1Yo",
-	'test[1][No]': '1No',
-	normalProperty: 123
-}
-
-test3 = {
-	test: [
-		{
-			Yo: "0Yo",
-			No: "0No"
-		},
-		{
-			Yo: "1Yo",
-			No: "1No"
-		}
-	],
-	normalProperty: 123
-}
-
-input4 = {
-	'test[Blah][Yack]': 'BlahYack',
-	'test[Blah][Blah]': 'BlahBlah'
-}
-
-test4 = {
-	test: {
-		Blah: {
-			Yack: 'BlahYack',
-			Blah: 'BlahBlah'
-		}
-	}
-}
-
-var arrayMatch = /\[\d+\]/;
-var objMatch = /\[[a-zA-Z][a-zA-Z\d]*\]/;
-var allMatch = /^[a-zA-Z\d_\-]+|\[[a-zA-Z\d_\-][a-zA-Z_\-\d]*\]|\[\d+\]/g;
-
-/*  Copyright (C) 2012-2014  Kurt Milam - http://xioup.com | Source: https://gist.github.com/1868955
- *   
- *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- *  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
- *
- *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-**/
-
-// Based conceptually on the _.extend() function in underscore.js ( see http://documentcloud.github.com/underscore/#extend for more details )
-
-function deepExtend(obj, depth = 0) {
-	const MAX_DEPTH = 20; // Prevent infinite recursion
-	if (depth > MAX_DEPTH) {
-		console.warn('Maximum depth exceeded in deepExtend');
-		return obj;
-	}
-
-	var parentRE = /#{\s*?_\s*?}/,
-		slice = Array.prototype.slice;
-
-	_.each(slice.call(arguments, 1), function (source) {
-		for (var prop in source) {
-			if (_.isUndefined(obj[prop]) || _.isFunction(obj[prop]) || _.isNull(source[prop]) || _.isDate(source[prop])) {
-				obj[prop] = source[prop];
-			}
-			else if (_.isString(source[prop]) && parentRE.test(source[prop])) {
-				if (_.isString(obj[prop])) {
-					obj[prop] = source[prop].replace(parentRE, obj[prop]);
-				}
-			}
-			else if (_.isArray(obj[prop]) || _.isArray(source[prop])) {
-				if (!_.isArray(obj[prop]) || !_.isArray(source[prop])) {
-					throw new Error('Trying to combine an array with a non-array (' + prop + ')');
-				} else {
-					obj[prop] = _.reject(_.deepExtend(_.clone(obj[prop]), source[prop], depth + 1), function (item) { return _.isNull(item); });
-				}
-			}
-			else if (_.isObject(obj[prop]) || _.isObject(source[prop])) {
-				if (!_.isObject(obj[prop]) || !_.isObject(source[prop])) {
-					throw new Error('Trying to combine an object with a non-object (' + prop + ')');
-				} else {
-					obj[prop] = _.deepExtend(_.clone(obj[prop]), source[prop], depth + 1);
-				}
-			} else {
-				obj[prop] = source[prop];
-			}
-		}
-	});
-	return obj;
-};
-
-_.mixin({ 'deepExtend': deepExtend });
-
-/**
- * Dependency: underscore.js ( http://documentcloud.github.com/underscore/ )
- *
- * Mix it in with underscore.js:
- * _.mixin({deepExtend: deepExtend});
- * 
- * Call it like this:
- * var myObj = _.deepExtend(grandparent, child, grandchild, greatgrandchild)
- *
- * Notes:
- * Keep it DRY.
- * This function is especially useful if you're working with JSON config documents. It allows you to create a default
- * config document with the most common settings, then override those settings for specific cases. It accepts any
- * number of objects as arguments, giving you fine-grained control over your config document hierarchy.
- *
- * Special Features and Considerations:
- * - parentRE allows you to concatenate strings. example:
- *   var obj = _.deepExtend({url: "www.example.com"}, {url: "http://#{_}/path/to/file.html"});
- *   console.log(obj.url);
- *   output: "http://www.example.com/path/to/file.html"
- *
- * - parentRE also acts as a placeholder, which can be useful when you need to change one value in an array, while
- *   leaving the others untouched. example:
- *   var arr = _.deepExtend([100,    {id: 1234}, true,  "foo",  [250, 500]],
- *                          ["#{_}", "#{_}",     false, "#{_}", "#{_}"]);
- *   console.log(arr);
- *   output: [100, {id: 1234}, false, "foo", [250, 500]]
- *
- * - The previous example can also be written like this:
- *   var arr = _.deepExtend([100,    {id:1234},   true,  "foo",  [250, 500]],
- *                          ["#{_}", {},          false, "#{_}", []]);
- *   console.log(arr);
- *   output: [100, {id: 1234}, false, "foo", [250, 500]]
- *
- * - And also like this:
- *   var arr = _.deepExtend([100,    {id:1234},   true,  "foo",  [250, 500]],
- *                          ["#{_}", {},          false]);
- *   console.log(arr);
- *   output: [100, {id: 1234}, false, "foo", [250, 500]]
- *
- * - Array order is important. example:
- *   var arr = _.deepExtend([1, 2, 3, 4], [1, 4, 3, 2]);
- *   console.log(arr);
- *   output: [1, 4, 3, 2]
- *
- * - You can remove an array element set in a parent object by setting the same index value to null in a child object.
- *   example:
- *   var obj = _.deepExtend({arr: [1, 2, 3, 4]}, {arr: ["#{_}", null]});
- *   console.log(obj.arr);
- *   output: [1, 3, 4]
- *
- **/
-
-function isNumeric(n) {
-	return !isNaN(parseFloat(n)) && isFinite(n);
-}
-
-function isArray(a) {
-	return Array.isArray(a);
-}
-
-var assignPropVal = function (parts, result, val, depth = 0) {
-	const MAX_DEPTH = 20; // Prevent infinite recursion
-	if (depth > MAX_DEPTH) {
-		console.warn('Maximum depth exceeded in assignPropVal');
-		return result;
-	}
-
-	var part = parts.shift().replace(/\[|\]/g, "");
-	if (parts.length) {
-		if (isNumeric(parts[0].replace(/\[|\]/g, ""))) {
-			result[part] = [];
-		} else {
-			result[part] = {};
-		}
-		assignPropVal(parts, result[part], val, depth + 1);
-	} else {
-		result[part] = val;
-	}
-	return result;
-}
-
-var deserialize = function (input) {
-	// console.log("INPUT", input);
-	var result = {};
-	var newobj = {};
-	for (prop in input) {
-		var parts = prop.match(allMatch);
-		// console.log(prop, parts);
-		var val = input[prop];
-		if (parts) {
-			var tmp = assignPropVal(parts, result, val, 0);
-			newobj = _.deepExtend(tmp);
-		} else {
-			// console.log("NOT ARRAY", parts);
-			newobj[prop] = input[prop];
-		}
-	}
-	// input = newobj;
-	// console.log("Munge!", newobj);
-	return newobj;
-}
-
-var runTest = function (name, input, test) {
-	var result = deserialize(input);
-	if (_.isEqual(result, test)) {
-		console.log("PASSED " + name);
-	} else {
-		console.log("FAILED " + name);
-		console.log(result);
-	}
-}
-
-var test = function () {
-	runTest("Test 1", input1, test1);
-	runTest("Test 2", input2, test2);
-	runTest("Test 3", input3, test3);
-	runTest("Test 4", input4, test4);
-}
-
-module.exports = {
-	deserialize: deserialize
-}