jxp 2.16.0 → 4.0.0

package/package.json

@@ -1,70 +1,122 @@
 {
-  "name": "jxp",
-  "description:": "An opinionated RESTful API library based on Mongoose and Restify. Make an API by just writing Mongoose models.",
-  "version": "2.16.0",
-  "private": false,
-  "main": "libs/jxp.js",
-  "scripts": {
-    "start": "node bin/server.js",
-    "test": "mocha --timeout 1000 -b --exit",
-    "wstest": "mocha test/wstest",
-    "setup": "node bin/setup.js"
-  },
-  "bin": {
-    "jxp": "bin/setup.js",
-    "jxp-setup": "bin/setup.js",
-    "jxp-add-admin": "bin/init_db.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/WorkSpaceMan/jxp.git"
-  },
-  "keywords": [
-    "api",
-    "mongoose"
-  ],
-  "author": "Jason Norwood-Young <jason@10layer.com> (https://github.com/j-norwood-young/)",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/WorkSpaceMan/jxp/issues"
-  },
-  "dependencies": {
-    "axios": "^1.8.4",
-    "bcryptjs": "^3.0.2",
-    "commander": "^13.1.0",
-    "config": "^3.3.12",
-    "dotenv": "^16.4.7",
-    "glob": "11.0.1",
-    "js-yaml": "4.1.0",
-    "json2csv": "^5.0.7",
-    "jsonwebtoken": "^9.0.2",
-    "jstransformer-markdown-it": "^3.0.0",
-    "jxp-helper": "^1.4.3",
-    "mkdirp": "^3.0.1",
-    "moment": "^2.30.1",
-    "mongoose": "6.12.6",
-    "mongoose-friendly": "^0.1.4",
-    "morgan": "^1.10.0",
-    "node-cache": "^5.1.2",
-    "nodemailer": "^6.10.0",
-    "nodemailer-smtp-transport": "^2.7.4",
-    "path": "^0.12.7",
-    "pug": "^3.0.3",
-    "querystring": "^0.2.1",
-    "rand-token": "^1.0.1",
-    "readline-sync": "^1.4.10",
-    "restify": "^11.1.0",
-    "restify-cors-middleware2": "^2.2.1",
-    "restify-errors": "^8.0.2",
-    "traverse": "^0.6.11",
-    "underscore": "^1.13.7",
-    "ws": "^8.18.1"
-  },
-  "devDependencies": {
-    "chai": "^4.3.10",
-    "chai-http": "^4.4.0",
-    "mocha": "^10.2.0",
-    "moment": "^2.29.4",
-    "should": "^13.2.3"
-  }
-}
+	"name": "jxp",
+	"description": "An opinionated RESTful API library based on Mongoose and Restify. Make an API by just writing Mongoose models.",
+	"version": "4.0.0",
+	"private": false,
+	"main": "dist/libs/jxp.js",
+	"types": "dist/libs/jxp.d.ts",
+	"files": [
+		"dist",
+		".env.sample",
+		"templates",
+		"docs",
+		"mkdocs.yml"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/libs/jxp.d.ts",
+			"default": "./dist/libs/jxp.js"
+		},
+		"./libs/schema": {
+			"types": "./dist/libs/schema.d.ts",
+			"default": "./dist/libs/schema.js"
+		},
+		"./libs/query_manipulation": {
+			"types": "./dist/libs/query_manipulation.d.ts",
+			"default": "./dist/libs/query_manipulation.js"
+		},
+		"./globals": {
+			"types": "./dist/globals.d.ts",
+			"default": "./dist/globals.js"
+		},
+		"./libs/load-config": {
+			"types": "./dist/libs/load-config.d.ts",
+			"default": "./dist/libs/load-config.js"
+		},
+		"./libs/connection_string": {
+			"types": "./dist/libs/connection_string.d.ts",
+			"default": "./dist/libs/connection_string.js"
+		},
+		"./types/jxp-config": {
+			"types": "./dist/types/jxp-config.d.ts"
+		}
+	},
+	"scripts": {
+		"build": "tsc -p tsconfig.build.json",
+		"prepublishOnly": "npm run build",
+		"prepare": "node -e \"require('fs').existsSync('src')&&require('child_process').execSync('npm run build',{stdio:'inherit'})\"",
+		"start": "node dist/bin/server.js",
+		"dev": "nodemon --watch src --ext ts --exec 'npm run build && node dist/bin/server.js'",
+		"test": "npm run build && mocha --require test/env.js --timeout 1000 -b --exit",
+		"setup": "node dist/bin/setup.js"
+	},
+	"bin": {
+		"jxp": "dist/bin/setup.js",
+		"jxp-setup": "dist/bin/setup.js",
+		"jxp-add-admin": "dist/bin/init_db.js"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git://github.com/WorkSpaceMan/jxp.git"
+	},
+	"keywords": [
+		"api",
+		"mongoose",
+		"typescript"
+	],
+	"author": "Jason Norwood-Young <jason@10layer.com> (https://github.com/j-norwood-young/)",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/WorkSpaceMan/jxp/issues"
+	},
+	"dependencies": {
+		"bcryptjs": "^3.0.2",
+		"commander": "^13.1.0",
+		"dotenv": "^16.5.0",
+		"glob": "11.1.0",
+		"js-yaml": "4.1.1",
+		"@json2csv/plainjs": "^7.0.6",
+		"jsonwebtoken": "^9.0.2",
+		"markdown-it": "^14.1.1",
+		"jxp-helper": "^1.4.3",
+		"moment": "^2.30.1",
+		"mongoose": "6.13.9",
+		"mongoose-friendly": "^0.1.4",
+		"morgan": "^1.10.0",
+		"node-cache": "^5.1.2",
+		"nodemailer": "^8.0.7",
+		"pug": "^3.0.3",
+		"rand-token": "^1.0.1",
+		"readline-sync": "^1.4.10",
+		"restify": "^11.1.0",
+		"restify-cors-middleware2": "^2.2.1",
+		"restify-errors": "^8.0.2",
+		"traverse": "^0.6.11",
+		"underscore": "^1.13.8",
+		"ws": "^8.18.1"
+	},
+	"devDependencies": {
+		"@types/markdown-it": "^14.1.2",
+		"@types/bcryptjs": "^2.4.6",
+		"@types/jsonwebtoken": "^9.0.9",
+		"@types/morgan": "^1.9.9",
+		"@types/node": "^22.15.21",
+		"@types/underscore": "^1.13.0",
+		"@types/ws": "^8.18.1",
+		"chai": "^4.3.10",
+		"chai-http": "^4.4.0",
+		"mocha": "^11.7.5",
+		"nodemon": "^3.1.0",
+		"should": "^13.2.3",
+		"typescript": "^5.8.3"
+	},
+	"engines": {
+		"node": ">=22.0.0"
+	},
+	"overrides": {
+		"find-my-way": "^8.2.2",
+		"send": "^0.19.0",
+		"serialize-javascript": "^7.0.5",
+		"diff": "^8.0.3"
+	}
+}

package/templates/api.pug

@@ -0,0 +1,32 @@
+extends layout
+
+block content
+  h1.mb-1 API reference
+  p.text-muted.mb-4 Explore resources, try requests with your API key, and inspect schemas.
+
+  if model_summaries.length
+    .table-responsive
+      table.table.table-striped.table-hover.align-middle
+        thead
+          tr
+            th Resource
+            th Collection
+            th Permissions
+            th
+        tbody
+          each summary in model_summaries
+            tr
+              td
+                a.fw-semibold(href="/docs/model/" + summary.slug)= summary.slug
+              td
+                code.small= summary.collection
+              td
+                if summary.perms
+                  each value, key in summary.perms
+                    span.badge.text-bg-secondary.me-1(title=key)= key + ': ' + value
+                else
+                  span.badge.text-bg-warning No perms
+              td.text-end
+                a.btn.btn-sm.btn-outline-primary(href="/docs/model/" + summary.slug) Open
+  else
+    .alert.alert-info No API resources are registered.

package/templates/app-server.js

@@ -0,0 +1,43 @@
+require("dotenv").config();
+const mongoose = require("mongoose");
+const JXP = require("jxp");
+const { loadJxpConfig, getMongoConnectionString } = require("jxp/libs/load-config");
+
+const apiconfig = loadJxpConfig();
+
+apiconfig.callbacks = {
+	post: function () {},
+	put: function () {},
+	delete: function () {},
+};
+
+apiconfig.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(),
+};
+
+mongoose.Promise = Promise;
+const mongo_options = Object.assign({}, apiconfig.mongo?.options || {}, {
+	useNewUrlParser: true,
+	useUnifiedTopology: true,
+});
+
+mongoose.connect(getMongoConnectionString(), mongo_options);
+
+mongoose.connection.on("error", console.error.bind(console, "connection error:"));
+mongoose.connection.once("open", () => {
+	console.log(`Connected to Mongo at: ${new Date()}`);
+});
+
+const server = JXP(apiconfig);
+const port = parseInt(process.env.PORT || String(apiconfig.port || 4001), 10);
+
+server.listen(port, function () {
+	console.log("%s listening at %s", server.name, server.url);
+});
+
+module.exports = server;

package/templates/app.env.sample

@@ -0,0 +1,8 @@
+PORT={port}
+API_URL={url}
+MONGO_CONNECTION_STRING={connection_string}
+SHARED_SECRET={shared_secret}
+TOKEN_EXPIRY=86400
+REFRESH_TOKEN_EXPIRY=2678400
+MODEL_DIR=./models
+LOG_FILE=./logs/access.log

package/templates/assets/api-console.js

@@ -0,0 +1,133 @@
+(function () {
+	"use strict";
+
+	const STORAGE_KEY = "jxp_docs_api_key";
+	const STORAGE_REMEMBER = "jxp_docs_remember_key";
+
+	function getApiKey() {
+		const input = document.getElementById("docs-api-key");
+		return input ? input.value.trim() : "";
+	}
+
+	function loadStoredKey() {
+		if (localStorage.getItem(STORAGE_REMEMBER) !== "1") return;
+		const key = localStorage.getItem(STORAGE_KEY);
+		if (!key) return;
+		const input = document.getElementById("docs-api-key");
+		const remember = document.getElementById("docs-remember-key");
+		if (input) input.value = key;
+		if (remember) remember.checked = true;
+	}
+
+	function saveKeyIfRemembered() {
+		const remember = document.getElementById("docs-remember-key");
+		const input = document.getElementById("docs-api-key");
+		if (!remember || !input) return;
+		if (remember.checked) {
+			localStorage.setItem(STORAGE_REMEMBER, "1");
+			localStorage.setItem(STORAGE_KEY, input.value.trim());
+		} else {
+			localStorage.removeItem(STORAGE_REMEMBER);
+			localStorage.removeItem(STORAGE_KEY);
+		}
+	}
+
+	function formatBody(text) {
+		if (!text) return "";
+		try {
+			return JSON.stringify(JSON.parse(text), null, 2);
+		} catch {
+			return text;
+		}
+	}
+
+	function formatResponse(text) {
+		if (!text) return "(empty)";
+		try {
+			return JSON.stringify(JSON.parse(text), null, 2);
+		} catch {
+			return text;
+		}
+	}
+
+	async function sendRequest(panel) {
+		const method = panel.dataset.method;
+		const pathInput = panel.querySelector(".api-path-input");
+		const bodyInput = panel.querySelector(".api-body-input");
+		const responseEl = panel.querySelector(".api-response");
+		const metaEl = panel.querySelector(".api-response-meta");
+		const btn = panel.querySelector(".api-send-btn");
+
+		const path = pathInput ? pathInput.value.trim() : panel.dataset.defaultPath;
+		if (!path.startsWith("/")) {
+			responseEl.textContent = "Path must start with /";
+			responseEl.classList.remove("empty");
+			return;
+		}
+
+		const headers = { Accept: "application/json" };
+		const apiKey = getApiKey();
+		if (apiKey) headers["X-API-Key"] = apiKey;
+
+		const opts = { method, headers };
+		if (bodyInput && (method === "POST" || method === "PUT")) {
+			const raw = bodyInput.value.trim();
+			if (raw) {
+				headers["Content-Type"] = "application/json";
+				opts.body = raw;
+			}
+		}
+
+		btn.disabled = true;
+		responseEl.textContent = "Sending…";
+		responseEl.classList.remove("empty");
+		metaEl.textContent = "";
+
+		const start = performance.now();
+		try {
+			const res = await fetch(path, opts);
+			const elapsed = Math.round(performance.now() - start);
+			const text = await res.text();
+			responseEl.textContent = formatResponse(text);
+			metaEl.textContent = `HTTP ${res.status} ${res.statusText} · ${elapsed} ms`;
+			metaEl.className = "api-response-meta " + (res.ok ? "text-success" : "text-danger");
+		} catch (err) {
+			responseEl.textContent = String(err.message || err);
+			metaEl.textContent = "Request failed";
+			metaEl.className = "api-response-meta text-danger";
+		} finally {
+			btn.disabled = false;
+		}
+	}
+
+	function initPanel(panel) {
+		const sendBtn = panel.querySelector(".api-send-btn");
+		if (sendBtn) {
+			sendBtn.addEventListener("click", function () {
+				saveKeyIfRemembered();
+				sendRequest(panel);
+			});
+		}
+		const bodyInput = panel.querySelector(".api-body-input");
+		if (bodyInput) {
+			bodyInput.addEventListener("blur", function () {
+				bodyInput.value = formatBody(bodyInput.value);
+			});
+		}
+	}
+
+	document.addEventListener("DOMContentLoaded", function () {
+		loadStoredKey();
+
+		const keyInput = document.getElementById("docs-api-key");
+		const remember = document.getElementById("docs-remember-key");
+		if (keyInput) {
+			keyInput.addEventListener("change", saveKeyIfRemembered);
+		}
+		if (remember) {
+			remember.addEventListener("change", saveKeyIfRemembered);
+		}
+
+		document.querySelectorAll(".api-try-panel").forEach(initPanel);
+	});
+})();

package/templates/assets/docs.css

@@ -0,0 +1,227 @@
+:root {
+	--docs-sidebar-width: 280px;
+	--docs-topbar-height: 56px;
+	--docs-accent: #0d6efd;
+	--docs-sidebar-bg: #f8f9fa;
+	--docs-border: #dee2e6;
+}
+
+body.docs-body {
+	min-height: 100vh;
+	background: #fff;
+}
+
+.docs-topbar {
+	height: var(--docs-topbar-height);
+	border-bottom: 1px solid var(--docs-border);
+	background: #fff;
+	z-index: 1030;
+}
+
+.docs-brand {
+	font-weight: 600;
+	font-size: 1.1rem;
+	color: #212529;
+	text-decoration: none;
+}
+
+.docs-brand:hover {
+	color: var(--docs-accent);
+}
+
+.docs-shell {
+	display: flex;
+	min-height: calc(100vh - var(--docs-topbar-height));
+}
+
+.docs-sidebar {
+	width: var(--docs-sidebar-width);
+	flex-shrink: 0;
+	border-right: 1px solid var(--docs-border);
+	background: var(--docs-sidebar-bg);
+	overflow-y: auto;
+	padding: 1rem 0;
+	position: sticky;
+	top: var(--docs-topbar-height);
+	height: calc(100vh - var(--docs-topbar-height));
+}
+
+.docs-main {
+	flex: 1;
+	min-width: 0;
+	padding: 1.5rem 2rem 3rem;
+	max-width: 960px;
+}
+
+.docs-sidebar-section {
+	padding: 0 1rem;
+	margin-bottom: 1.25rem;
+}
+
+.docs-sidebar-title {
+	font-size: 0.7rem;
+	font-weight: 700;
+	text-transform: uppercase;
+	letter-spacing: 0.06em;
+	color: #6c757d;
+	margin-bottom: 0.5rem;
+}
+
+.docs-nav-link {
+	display: block;
+	padding: 0.35rem 0.75rem;
+	font-size: 0.875rem;
+	color: #495057;
+	text-decoration: none;
+	border-radius: 0.375rem;
+	border-left: 3px solid transparent;
+}
+
+.docs-nav-link:hover {
+	background: rgba(13, 110, 253, 0.08);
+	color: var(--docs-accent);
+}
+
+.docs-nav-link.active {
+	background: rgba(13, 110, 253, 0.12);
+	color: var(--docs-accent);
+	border-left-color: var(--docs-accent);
+	font-weight: 500;
+}
+
+.docs-api-key-wrap {
+	max-width: 220px;
+}
+
+.docs-api-key-wrap .form-control {
+	font-size: 0.8rem;
+	font-family: ui-monospace, monospace;
+}
+
+@media (max-width: 991.98px) {
+	.docs-sidebar {
+		display: none;
+	}
+
+	.docs-main {
+		padding: 1rem;
+	}
+}
+
+.docs-hero {
+	padding: 2.5rem 0 2rem;
+	border-bottom: 1px solid var(--docs-border);
+	margin-bottom: 2rem;
+}
+
+.docs-hero h1 {
+	font-size: 2.25rem;
+	font-weight: 700;
+	margin-bottom: 0.5rem;
+}
+
+.docs-hero .lead {
+	color: #6c757d;
+	max-width: 36rem;
+}
+
+.docs-content h1,
+.docs-content h2,
+.docs-content h3 {
+	margin-top: 1.5rem;
+	margin-bottom: 0.75rem;
+}
+
+.docs-content pre {
+	background: #f8f9fa;
+	border: 1px solid var(--docs-border);
+	border-radius: 0.375rem;
+	padding: 1rem;
+	overflow-x: auto;
+	font-size: 0.85rem;
+}
+
+.docs-content code {
+	font-size: 0.875em;
+	color: #d63384;
+}
+
+.docs-content pre code {
+	color: inherit;
+}
+
+.docs-content table {
+	margin: 1rem 0;
+}
+
+.method-badge {
+	font-family: ui-monospace, monospace;
+	font-size: 0.75rem;
+	font-weight: 700;
+	min-width: 4.5rem;
+	text-align: center;
+}
+
+.method-get { background-color: #198754 !important; }
+.method-post { background-color: #0d6efd !important; }
+.method-put { background-color: #fd7e14 !important; }
+.method-delete { background-color: #dc3545 !important; }
+
+.endpoint-path {
+	font-family: ui-monospace, monospace;
+	font-size: 0.9rem;
+}
+
+.api-try-panel {
+	border: 1px solid var(--docs-border);
+	border-radius: 0.375rem;
+	padding: 1rem;
+	background: #fafbfc;
+	margin-top: 0.75rem;
+}
+
+.api-response {
+	font-family: ui-monospace, monospace;
+	font-size: 0.8rem;
+	background: #212529;
+	color: #e9ecef;
+	border-radius: 0.375rem;
+	padding: 1rem;
+	max-height: 320px;
+	overflow: auto;
+	white-space: pre-wrap;
+	word-break: break-word;
+	margin-top: 0.75rem;
+}
+
+.api-response.empty {
+	background: #f8f9fa;
+	color: #6c757d;
+	border: 1px dashed var(--docs-border);
+}
+
+.api-response-meta {
+	font-size: 0.8rem;
+	color: #6c757d;
+	margin-top: 0.5rem;
+}
+
+.field-details pre {
+	font-size: 0.75rem;
+	max-height: 200px;
+	overflow: auto;
+}
+
+.feature-card {
+	height: 100%;
+	border: 1px solid var(--docs-border);
+	transition: box-shadow 0.15s ease;
+}
+
+.feature-card:hover {
+	box-shadow: 0 0.25rem 0.75rem rgba(0, 0, 0, 0.08);
+}
+
+.docs-security-note {
+	font-size: 0.8rem;
+}