jxp 2.16.0 → 4.0.0

package/templates/index.pug

@@ -1,4 +1,64 @@
 extends layout
 
-block content  
-  include:markdown-it ../docs/index.md
+block content
+  .docs-hero
+    h1= name
+    p.lead
+      | REST API powered by 
+      a(href="https://jxp.readthedocs.io" target="_blank" rel="noopener") JXP
+      |  — define Mongoose schemas, get a full API with auth, permissions, and smart queries.
+    .d-flex.flex-wrap.gap-2.mt-3
+      if first_guide_url
+        a.btn.btn-primary(href=first_guide_url) Get started
+      a.btn.btn-outline-primary(href="/docs/api") Browse API
+      a.btn.btn-outline-secondary(href="/docs/md/api.md") REST reference
+
+  .row.g-4.mb-4
+    .col-md-6
+      .card.h-100
+        .card-header.fw-semibold Quick start
+        .card-body
+          p.mb-2 Authenticate with an API key header (optional for exploring docs; required for live calls):
+          pre.mb-3
+            code.
+              curl -H "X-API-Key: YOUR_KEY" \
+                "#{base_url}/api/MODEL?limit=5"
+          p.mb-0.small.text-muted
+            | Set your key in the top bar to use 
+            strong Try it 
+            |  panels on API resource pages. Keys are stored in the browser only when “Remember” is checked.
+    .col-md-6
+      .card.h-100
+        .card-header.fw-semibold API at a glance
+        .card-body
+          p.mb-2
+            strong= model_list.length
+            |  resource#{model_list.length !== 1 ? 's' : ''} registered
+          if model_list.length
+            .d-flex.flex-wrap.gap-1
+              each m in model_list.slice(0, 12)
+                a.badge.text-bg-light.text-decoration-none(href="/docs/model/" + m)= m
+              if model_list.length > 12
+                a.badge.text-bg-secondary.text-decoration-none(href="/docs/api") +#{model_list.length - 12} more
+          else
+            p.text-muted.mb-0 No models loaded yet.
+
+  h2.h4.mb-3 Features
+  .row.g-3.mb-4
+    each feature in features
+      .col-md-6.col-lg-4
+        .card.feature-card
+          .card-body
+            h3.h6.card-title= feature.title
+            p.card-text.small.text-muted.mb-0= feature.description
+
+  h2.h4.mb-3 Links
+  ul.list-unstyled
+    li.mb-1
+      a(href="https://www.npmjs.com/package/jxp" target="_blank" rel="noopener") JXP on NPM
+    li.mb-1
+      a(href="https://github.com/WorkSpaceMan/jxp" target="_blank" rel="noopener") GitHub
+    li.mb-1
+      a(href="https://www.npmjs.com/package/jxp-helper" target="_blank" rel="noopener") jxp-helper client
+    li
+      a(href="https://jxp.readthedocs.io" target="_blank" rel="noopener") Read the Docs

package/templates/layout.pug

@@ -1,12 +1,18 @@
 doctype html
-html
-    head
-        title= title
-        link(rel='stylesheet', href='https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css')
-    body
-        include navbar
-        .container
-            block content
-        script(src="https://code.jquery.com/jquery-3.5.1.min.js")
-        script(src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.bundle.min.js")
-        block javascripts
+html(lang="en")
+  head
+    meta(charset="utf-8")
+    meta(name="viewport" content="width=device-width, initial-scale=1")
+    title= title
+    link(rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/css/bootstrap.min.css" crossorigin="anonymous")
+    link(rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css")
+    link(rel="stylesheet" href="/docs/assets/docs.css")
+  body.docs-body
+    include navbar
+    .docs-shell
+      include sidebar
+      main.docs-main
+        block content
+    script(src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js" crossorigin="anonymous")
+    script(src="/docs/assets/api-console.js" defer)
+    block javascripts

package/templates/md.pug

@@ -1,5 +1,5 @@
 extends layout
 
 block content
+  article.docs-content
     != md_contents
-    

package/templates/model.pug

@@ -1,75 +1,124 @@
 extends layout
 
 block content
-    h1= "Model " + model.collection.name
-    hr
-    h2 Permissions
-    if perms
-        table.table
-            thead
-                tr
-                    th User Group
-                    th Create?
-                    th Read?
-                    th Update?
-                    th Delete?
-            tbody
-                each value, key in perms
-                    tr
-                        td= key
-                        td= value.includes("c") ? "x" : ""
-                        td= value.includes("r") ? "x" : ""
-                        td= value.includes("u") ? "x" : ""
-                        td= value.includes("d") ? "x" : ""
-    else
-        .alert.alert-warning No permissions defined for this model, it will not be accessible through the API
+  nav.mb-3(aria-label="breadcrumb")
+    ol.breadcrumb
+      li.breadcrumb-item
+        a(href="/docs/api") API
+      li.breadcrumb-item.active(aria-current="page")= model_slug
 
-    hr
-    h2 Fields
-    table.table
+  h1.mb-1= model_slug
+  p.text-muted
+    | Collection: 
+    code= collection_name
+    |  · 
+    a(href="/docs/md/api.md") Query & filter docs
+
+  h2.h4.mt-4.mb-3 Endpoints
+  p.small.text-muted.mb-3
+    | Optional 
+    code X-API-Key 
+    |  in the top bar. 
+    span.text-warning Keys in the browser are for development only.
+
+  .accordion#apiEndpointsAccordion
+    each endpoint, idx in endpoints
+      .accordion-item
+        h2.accordion-header(id="heading-" + idx)
+          button.accordion-button(class=(idx === 0 ? '' : 'collapsed') type="button" data-bs-toggle="collapse" data-bs-target="#collapse-" + idx aria-expanded=(idx === 0 ? 'true' : 'false') aria-controls="collapse-" + idx)
+            span.badge.method-badge.me-2(class='method-' + endpoint.method.toLowerCase())= endpoint.method
+            span.endpoint-path= endpoint.path
+        .accordion-collapse.collapse(class=(idx === 0 ? 'show' : '') id="collapse-" + idx aria-labelledby="heading-" + idx data-bs-parent="#apiEndpointsAccordion")
+          .accordion-body
+            p.mb-2= endpoint.description
+            if endpoint.queryHint
+              p.small.text-muted= endpoint.queryHint
+            .api-try-panel(data-method=endpoint.method data-default-path=endpoint.path)
+              .mb-2
+                label.form-label.small.fw-semibold Request URL
+                .input-group.input-group-sm
+                  span.input-group-text= endpoint.method
+                  input.form-control.api-path-input(type="text" value=endpoint.path)
+              if endpoint.hasBody
+                .mb-2
+                  label.form-label.small.fw-semibold JSON body
+                  textarea.form-control.api-body-input.font-monospace(rows="4" placeholder='{"field": "value"}') {}
+              button.btn.btn-primary.btn-sm.api-send-btn(type="button")
+                i.bi.bi-play-fill.me-1
+                | Send request
+              .api-response.empty(role="status") Response will appear here…
+              .api-response-meta
+
+  hr.my-4
+
+  h2.h4 Permissions
+  if perms
+    .table-responsive
+      table.table.table-striped.table-sm
         thead
-            tr
-                th Name
-                th Type
-                th Link
-                th Maps To
-                th Default
-                th Indexed?
-                th Unique?
-                th Required?
+          tr
+            th User Group
+            th Create
+            th Read
+            th Update
+            th Delete
         tbody
-            each fieldname in fields
-                - let field = safeFields[fieldname]
-                if (field.path)
-                    tr
-                        td= field.path
-                        td
-                            if field.arrayType
-                                | Array of #{field.arrayType}
-                            else
-                                = field.instance
-                        td= field.options.link
-                        td= field.options.map_to
-                        td= field.defaultValue
-                        td= (field.options.index) ? "x" : ""
-                        td= (field.options.unique) ? "x" : ""
-                        td= field.isRequired ? "x" : ""
-    hr
-    h2 Field Details
-    each fieldname in fields
-        - let field = safeFields[fieldname]
-        if field
-            .field-details
-                h3= field.path
-                pre.pre= JSON.stringify(field, null, 2)
-                if field.schema
-                    h4 Nested Schema
-                    ul
-                        each nestedField in field.schema
-                            li #{nestedField.path}: #{nestedField.type}
-                if field.validators && field.validators.length
-                    h4 Validators
-                    ul
-                        each validator in field.validators
-                            li #{validator.type}: #{validator.message}
+          each value, key in perms
+            tr
+              td= key
+              td= value.includes("c") ? "✓" : ""
+              td= value.includes("r") ? "✓" : ""
+              td= value.includes("u") ? "✓" : ""
+              td= value.includes("d") ? "✓" : ""
+  else
+    .alert.alert-warning No permissions defined — this resource may not be accessible via the API.
+
+  h2.h4.mt-4 Fields
+  .table-responsive
+    table.table.table-striped.table-sm
+      thead
+        tr
+          th Name
+          th Type
+          th Link
+          th Maps To
+          th Default
+          th Indexed
+          th Unique
+          th Required
+      tbody
+        each fieldname in fields
+          - let field = safeFields[fieldname]
+          if field && field.path
+            tr
+              td
+                code= field.path
+              td
+                if field.arrayType
+                  span.badge.text-bg-info Array of #{field.arrayType}
+                else
+                  span.badge.text-bg-light.text-dark= field.instance
+              td= field.options.link || ''
+              td= field.options.map_to || ''
+              td.small= field.defaultValue != null ? field.defaultValue : ''
+              td= field.options.index ? "✓" : ""
+              td= field.options.unique ? "✓" : ""
+              td= field.isRequired ? "✓" : ""
 
+  h2.h4.mt-4 Field details
+  each fieldname in fields
+    - let field = safeFields[fieldname]
+    if field
+      .field-details.mb-3
+        h3.h6= field.path
+        pre.pre.small.bg-light.p-2.rounded= JSON.stringify(field, null, 2)
+        if field.schema
+          h4.h6 Nested schema
+          ul.small
+            each nestedField in field.schema
+              li #{nestedField.path}: #{nestedField.type}
+        if field.validators && field.validators.length
+          h4.h6 Validators
+          ul.small
+            each validator in field.validators
+              li #{validator.type}: #{validator.message}

package/templates/navbar.pug

@@ -1,21 +1,14 @@
-nav.navbar.navbar-expand-lg.navbar-light
-    a.navbar-brand(href="/")
-        h1= name
-    button.navbar-toggler(type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation")
-        span.navbar-toggler-icon
-    #navbarSupportedContent.collapse.navbar-collapse
-        ul.navbar-nav.mr-auto
-            li.nav-item.dropdown(class=models)
-                a#navbarDropdown.nav-link.dropdown-toggle(href="#" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false") Model Reference
-                .dropdown-menu(aria-labelledby="navbarDropdown")
-                    each model_name in model_list
-                        a.dropdown-item.btn(href="/docs/model/" + model_name)= model_name
-            li.nav-item.dropdown(class=documentation)
-                a#navbarDropdown.nav-link.dropdown-toggle(href="#" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false") Guides
-                .dropdown-menu(aria-labelledby="navbarDropdown")
-                    each nav of guide_nav
-                        a.dropdown-item.btn(href="/docs/md/" + Object.values(nav)[0])= Object.keys(nav)[0]
-        = "v" + version
-        //- form.form-inline.my-2.my-lg-0(method="GET" action="/search")
-        //-     input.form-control.mr-sm-2(name="query" type="search" placeholder="Search" aria-label="Search" value=query)
-        //-     button.btn.btn-outline-success.my-2.my-sm-0(type="submit") Search
+header.docs-topbar.navbar.navbar-expand-lg.sticky-top
+  .container-fluid.px-3
+    button.btn.btn-outline-secondary.btn-sm.d-lg-none.me-2(type="button" data-bs-toggle="offcanvas" data-bs-target="#docsSidebarOffcanvas" aria-controls="docsSidebarOffcanvas" aria-label="Open navigation")
+      i.bi.bi-list
+    a.docs-brand.navbar-brand.mb-0(href="/")= name
+    span.badge.bg-secondary.ms-2.align-self-center v#{version}
+    .ms-auto.d-flex.align-items-center.gap-2.flex-wrap
+      .docs-api-key-wrap
+        label.visually-hidden(for="docs-api-key") API Key
+        input#docs-api-key.form-control.form-control-sm(type="password" placeholder="X-API-Key (optional)" autocomplete="off")
+      .form-check.form-check-inline.mb-0.docs-security-note
+        input#docs-remember-key.form-check-input(type="checkbox")
+        label.form-check-label(for="docs-remember-key") Remember
+      span.docs-security-note.text-muted.d-none.d-md-inline Dev only

package/templates/sidebar.pug

@@ -0,0 +1,30 @@
+nav.docs-sidebar#docsSidebarDesktop(aria-label="Documentation navigation")
+  .docs-sidebar-section
+    .docs-sidebar-title Guides
+    each nav in guide_nav
+      - const label = Object.keys(nav)[0]
+      - const file = Object.values(nav)[0]
+      a.docs-nav-link(href="/docs/md/" + file class=(active_guide === file ? 'active' : ''))= label
+  .docs-sidebar-section
+    .docs-sidebar-title API
+    a.docs-nav-link(href="/docs/api" class=(active_section === 'api' && !active_model ? 'active' : '')) Overview
+    each model_name in model_list
+      a.docs-nav-link(href="/docs/model/" + model_name class=(active_model === model_name ? 'active' : ''))= model_name
+
+//- Mobile offcanvas (same links)
+.offcanvas.offcanvas-start#docsSidebarOffcanvas(tabindex="-1" aria-labelledby="docsSidebarOffcanvasLabel")
+  .offcanvas-header
+    h5.offcanvas-title#docsSidebarOffcanvasLabel Navigation
+    button.btn-close(type="button" data-bs-dismiss="offcanvas" aria-label="Close")
+  .offcanvas-body.p-0
+    .docs-sidebar-section
+      .docs-sidebar-title Guides
+      each nav in guide_nav
+        - const label = Object.keys(nav)[0]
+        - const file = Object.values(nav)[0]
+        a.docs-nav-link(href="/docs/md/" + file class=(active_guide === file ? 'active' : ''))= label
+    .docs-sidebar-section
+      .docs-sidebar-title API
+      a.docs-nav-link(href="/docs/api" class=(active_section === 'api' && !active_model ? 'active' : '')) Overview
+      each model_name in model_list
+        a.docs-nav-link(href="/docs/model/" + model_name class=(active_model === model_name ? 'active' : ''))= model_name

package/.env

@@ -1,9 +0,0 @@
-MONGODB_HOST=127.0.0.1
-MONGODB_PORT=27017
-MONGODB_NAME=dev
-MONGODB_AUTH_DB=admin
-MONGODB_USER=
-MONGODB_PASS=
-
-NODE_LOCAL_PORT=4001
-NODE_DOCKER_PORT=4001

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,29 +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",
-                "999999",
-                "--colors",
-                "${workspaceFolder}/test"
-            ],
-            "internalConsoleOptions": "openOnSessionStart"
-        }
-    ]
-}

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,84 +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, {});
-
-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', console.error.bind(console, 'connection error:'));
-
-// mongodb connection open
-db.once('open', () => {
-	console.log(`Connected to Mongo at: ${new Date()}`);
-});
-
-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