@the-starport/nodebb-plugin-mdx-page-renderer 1.0.0 → 1.0.1

package/lib/controllers.js

@@ -18,8 +18,10 @@ const sitemapLib   = require('./sitemap');
 const sources      = require('./sources');
 const { resolveLocalPath } = sources;
 const staticExport = require('./static-export');
+const {fixPrefixPath} = require("./utils");
 
 const user = require.main.require('./src/user');
+const winston = require.main.require('winston');
 
 // Public controllers
 
@@ -35,22 +37,26 @@ const user = require.main.require('./src/user');
  * @returns {Promise<void>}
  */
 async function renderPage(req, res, next) {
-    // Strip /api prefix if present. ajaxify fetches /api/{path} for SPA
-    // navigation; the catch-all in library.js dispatches both forms here.
+    // Strip /api prefix if present. ajaxify fetches /api/{path} for SPA navigation
     const urlPath = (req.path.startsWith('/api/')
-        ? req.path.slice(4)
-        : req.path
-    ).replace(/^\/+/, '');
+            ? req.path.slice(4)
+            : req.path
+    )
 
+    // Grab the possible sources this route matches
     const matchingSources = sources.getAll().filter(function (s) {
-        return urlPath === s.urlPrefix || urlPath.startsWith(s.urlPrefix + '/');
+        const urlPrefix = fixPrefixPath(s.urlPrefix);
+        return urlPath.startsWith(urlPrefix);
     });
 
     // Longest prefix wins (e.g. "wiki/guide" over "wiki") when both match.
-    matchingSources.sort(function (a, b) { return b.urlPrefix.length - a.urlPrefix.length; });
+    matchingSources.sort(function (a, b) { return fixPrefixPath(b.urlPrefix).length - fixPrefixPath(a.urlPrefix).length; });
 
-    const prefix  = matchingSources.length ? matchingSources[0].urlPrefix : '';
-    const rawPath = urlPath.startsWith(prefix + '/') ? urlPath.slice(prefix.length + 1) : '';
+    let prefix  = matchingSources.length ? matchingSources[0].urlPrefix : '';
+    const rawPath = req.params[0] ? req.params[0] : '';
+
+    winston.verbose('[mdx-page-renderer] Matching prefix: ' + prefix);
+    winston.verbose('[mdx-page-renderer] Matching route: ' + rawPath);
 
     // Treat a bare prefix URL as a request for index.mdx.
     const effectivePath = rawPath || 'index';
@@ -70,19 +76,33 @@ async function renderPage(req, res, next) {
     }
 
     if (!filePath) {
+        winston.verbose('[mdx-page-renderer] Unable to find file path: ' + resolvedEffectivePath);
+
         // No content found for this path. Prompt to admins visiting the bare prefix URL; everyone else gets a 404.
         if (!rawPath) {
             const isAdmin = req.uid && await user.isAdministrator(req.uid);
             if (isAdmin) {
                 return res.render('mdx-page', {
                     title:   'MDX Page',
-                    content: buildNoContentHtml(prefix),
+                    content: buildNoContentHtml(fixPrefixPath(prefix)),
                 });
             }
         }
+
         return next();
     }
 
+    // Due to needing to handle relative paths, we need to invert any fixing of the prefix path in the same way here
+    if (prefix) {
+        if (prefix.charAt(0) === '/') {
+            prefix = prefix.substring(1, prefix.length);
+        }
+
+        if (prefix.slice(-1) === '/') {
+            prefix = prefix.substring(0, prefix.length - 1);
+        }
+    }
+
     try {
         const sourceText = fs.readFileSync(filePath, 'utf8');
 
@@ -117,7 +137,7 @@ async function renderPage(req, res, next) {
 
         res.render('mdx-page', { title, content: html, breadcrumbs, showSidebarToc, tocHtml });
     } catch (err) {
-        console.error('[mdx-page-renderer] Failed to render page ' + filePath + ':', err);
+        winston.error('[mdx-page-renderer] Failed to render page ' + filePath + ':', err);
         res.status(500).render('mdx-page', {
             title:   'Render error',
             content: '<p>Failed to render this page. Check the server logs for details.</p>' +

package/lib/sources.js

@@ -10,6 +10,28 @@
  * flagged for admin review.
  */
 
+/**
+ * @typedef {Object} SourceConfig
+ * @property {string} type
+ * @property {string} label
+ * @property {string} urlPrefix
+ * @property {string} url
+ */
+
+/**
+ * @typedef {Object} SourceObject
+ * @property {string} id
+ * @property {string} type
+ * @property {string} label
+ * @property {string} url
+ * @property {string} urlPrefix
+ * @property {string} localPath
+ * @property {string} createdAt
+ * @property {boolean} showIndexToc
+ * @property {string | undefined} asset
+ * @property {string | undefined} tag
+ */
+
 const crypto = require('crypto');
 const fs     = require('fs');
 const https  = require('https');
@@ -28,7 +50,8 @@ const settings = require('./settings');
 /** Database key used to persist the list of configured sources. */
 const DB_KEY = 'mdx-page-renderer:sources';
 
-/** In-memory list of source objects. Populated by loadAll(). */
+/** In-memory list of source objects. Populated by loadAll().
+ * @type {SourceObject[]} */
 let sourceList = [];
 
 // Public API
@@ -44,7 +67,7 @@ async function loadAll() {
 
 /**
  * getAll - returns a copy of the current source list.
- * @returns {object[]}
+ * @returns {SourceObject[]}
  */
 function getAll() {
     return [...sourceList];
@@ -62,7 +85,7 @@ function getById(id) {
 /**
  * add - validates, creates, and persists a new source.
  * Returns the created source object (with generated ID and localPath).
- * @param {{ type: string, label: string, url?: string, urlPrefix: string }} sourceConfig
+ * @param {SourceConfig} sourceConfig
  * @returns {Promise<object>} The created source object.
  */
 async function add(sourceConfig) {

package/lib/utils.js

@@ -0,0 +1,20 @@
+/**
+ * @param prefix {string} A url prefix
+ * @returns {string} The prefix with a forward slash added to the front, and removed from the end
+ */
+const fixPrefixPath = (prefix) => {
+    if (prefix.charAt(0) !== '/') {
+        prefix = '/' + prefix;
+    }
+
+    // Remove dangling slashes
+    if (prefix.slice(-1) === '/') {
+        prefix = prefix.substring(0, prefix.length - 1);
+    }
+
+    return prefix;
+}
+
+module.exports = {
+    fixPrefixPath,
+}

package/library.js

@@ -6,9 +6,11 @@
  */
 
 const controllers = require('./lib/controllers');
-const sources     = require('./lib/sources');
-const doxygen     = require('./lib/doxygen');
-const settings    = require('./lib/settings');
+const sources = require('./lib/sources');
+const doxygen = require('./lib/doxygen');
+const settings = require('./lib/settings');
+const {fixPrefixPath} = require("./lib/utils");
+const winston = require.main.require('winston');
 
 // Provides setupAdminPageRoute which applies the admin middleware stack and
 // auto-registers a /api/ JSON mirror of the route.
@@ -16,12 +18,14 @@ const routeHelpers = require.main.require('./src/routes/helpers');
 
 const Plugin = module.exports;
 
+const PLUGIN_NAME = 'mdx-page-renderer';
+
 /**
  * init - registered against the `static:app.load` hook.
  * @param {{ router: import('express').Router, middleware: object }} params
  * @returns {Promise<void>}
  */
-Plugin.init = async function ({ router, middleware }) {
+Plugin.init = async function ({router, middleware}) {
     await settings.load();
 
     // Load content and Doxygen data from any previously-configured sources.
@@ -36,53 +40,48 @@ Plugin.init = async function ({ router, middleware }) {
     // --- Admin panel page ---
     routeHelpers.setupAdminPageRoute(router, '/admin/plugins/mdx-page-renderer', controllers.renderAdmin);
 
-    // --- Admin mutation endpoints ---
-    const base = '/admin/plugins/mdx-page-renderer';
-    router.post(`${base}/save`,            controllers.saveSettings);
-    router.post(`${base}/source`,          controllers.addSource);
-    router.post(`${base}/source/update`,   controllers.updateSource);
-    router.post(`${base}/source/remove`,   controllers.removeSource);
-    router.post(`${base}/refresh`,         controllers.refreshSource);
-    router.post(`${base}/clear-cache`,     controllers.clearRenderCache);
-    router.post(`${base}/export`,          controllers.exportStatic);
-
-    // Inline source page editor endpoints
-    router.get(`${base}/inline/pages`,       controllers.listInlinePages);
-    router.get(`${base}/inline/page`,        controllers.getInlinePage);
-    router.post(`${base}/inline/page`,       controllers.saveInlinePage);
-    router.delete(`${base}/inline/page`,     controllers.deleteInlinePage);
-
-    // --- Content page catch-all ---
-    // One catch-all dispatches to the correct source at request time, so sources
-    // added in the admin panel take effect without a restart. Registered last so
-    // it does not shadow NodeBB's own routes.
-    router.get('*', function routeToDocPage(req, res, next) {
-        // ajaxify fetches /api/{path} for SPA navigation; strip it to get the real path.
-        const isApi   = req.path.startsWith('/api/');
-        const urlPath = (isApi ? req.path.slice(4) : req.path).replace(/^\/+/, '');
-
-        if (!urlPath) {
-            return next();
+    const availableSources = sources.getAll();
+    // Sort the array so the most specific routes are setup first
+    availableSources.sort(function (a, b) { return b.urlPrefix.length - a.urlPrefix.length; })
+    for (const source of availableSources) {
+        let prefix = source.urlPrefix;
+        if (!prefix) {
+            continue;
         }
 
-        // Match exact prefix or prefix followed by slash (supports multi-segment prefixes like "wiki/guide").
-        const matched = sources.getAll().some(function (s) {
-            return urlPath === s.urlPrefix || urlPath.startsWith(s.urlPrefix + '/');
-        });
+        prefix = fixPrefixPath(prefix);
 
-        if (!matched) {
-            return next();
-        }
+        winston.info(`[mdx-page-renderer] Registering source: ${prefix}`);
+        routeHelpers.setupPageRoute(router, `${prefix}/*`, controllers.renderPage)
+        routeHelpers.setupPageRoute(router, `${prefix}`, controllers.renderPage)
+    }
+};
 
-        if (isApi) {
-            // API requests come from ajaxify - buildHeader would interfere with the JSON response.
-            controllers.renderPage(req, res, next);
-        } else {
-            middleware.buildHeader(req, res, function (err) {
-                if (err) return next(err);
-                controllers.renderPage(req, res, next);
-            });
-        }
+Plugin.addRoutes = async ({router, middleware, helpers}) => {
+    const controllers = require('./lib/controllers');
+    const middlewares = [
+        middleware.authenticateRequest,
+        middleware.logApiUsage,
+        middleware.ensureLoggedIn,
+        middleware.admin.checkPrivileges,
+    ];
+
+    routeHelpers.setupApiRoute(router, 'post', `/${PLUGIN_NAME}/save`, middlewares, controllers.saveSettings);
+    routeHelpers.setupApiRoute(router, 'post', `/${PLUGIN_NAME}/source`, middlewares, controllers.addSource);
+    routeHelpers.setupApiRoute(router, 'post', `/${PLUGIN_NAME}/source/update`, middlewares, controllers.updateSource);
+    routeHelpers.setupApiRoute(router, 'post', `/${PLUGIN_NAME}/source/remove`, middlewares, controllers.removeSource);
+    routeHelpers.setupApiRoute(router, 'post', `/${PLUGIN_NAME}/refresh`, middlewares, controllers.refreshSource);
+    routeHelpers.setupApiRoute(router, 'post', `/${PLUGIN_NAME}/clear-cache`, middlewares, controllers.clearRenderCache);
+    routeHelpers.setupApiRoute(router, 'post', `/${PLUGIN_NAME}/export`, middlewares, controllers.exportStatic);
+
+    // Inline source page editor endpoints
+    routeHelpers.setupApiRoute(router, 'get', `/${PLUGIN_NAME}/inline/pages`, middlewares, controllers.listInlinePages);
+    routeHelpers.setupApiRoute(router, 'get', `/${PLUGIN_NAME}/inline/page`, middlewares, controllers.getInlinePage);
+    routeHelpers.setupApiRoute(router, 'post', `/${PLUGIN_NAME}/inline/page`, middlewares, controllers.saveInlinePage);
+    routeHelpers.setupApiRoute(router, 'delete', `/${PLUGIN_NAME}/inline/page`, middlewares, controllers.deleteInlinePage);
+
+    routeHelpers.setupApiRoute(router, 'get', `/test`, (req, res) => {
+        helpers.formatApiResponse(200, res, {})
     });
 };
 
@@ -93,9 +92,9 @@ Plugin.init = async function ({ router, middleware }) {
  */
 Plugin.addAdminNavigation = function (header) {
     header.plugins.push({
-        route:  '/plugins/mdx-page-renderer',
-        icon:   'fa-file-alt',
-        name:   'MDX Page Renderer',
+        route: '/plugins/mdx-page-renderer',
+        icon: 'fa-file-alt',
+        name: 'MDX Page Renderer',
     });
 
     return header;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@the-starport/nodebb-plugin-mdx-page-renderer",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Serves MDX-based documentation pages within NodeBB, with server-side rendering and Doxygen API reference components.",
   "main": "library.js",
   "repository": {

package/plugin.json

@@ -2,15 +2,21 @@
   "id": "nodebb-plugin-mdx-page-renderer",
   "name": "MDX Page Renderer",
   "description": "Serves MDX-based documentation pages within NodeBB with server-side rendering, Doxygen API reference components, and an admin panel for managing content sources.",
-  "version": "1.0.0",
-  "repository": {
-    "type": "git",
-    "url": "https://codeberg.org/TheStarport/nodebb-plugin-mdx-page-renderer"
-  },
+  "version": "1.0.1",
   "library": "./library.js",
   "hooks": [
-    { "hook": "static:app.load",           "method": "init" },
-    { "hook": "filter:admin.header.build", "method": "addAdminNavigation" }
+    {
+      "hook": "static:app.load",
+      "method": "init"
+    },
+    {
+      "hook": "filter:admin.header.build",
+      "method": "addAdminNavigation"
+    },
+    {
+      "hook": "static:api.routes",
+      "method": "addRoutes"
+    }
   ],
   "scss": [
     "mdx.scss"

package/public/admin.js

@@ -5,11 +5,11 @@
 /**
  * Admin panel AMD module for the MDX Page Renderer plugin.
  * Initial data comes from ajaxify.data (set by renderAdmin via res.render).
- * Mutations POST to /admin/plugins/mdx-page-renderer/* with a CSRF token.
+ * Mutations POST to /api/v3/plugins/mdx-page-renderer/* with a CSRF token.
  */
 define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alerts, bootbox) {
-    const BASE = '/admin/plugins/mdx-page-renderer';
-    const API = `/api${BASE}`;
+    const API = config.relative_path + '/api/v3/plugins/mdx-page-renderer';
+    const NAV_API = config.relative_path + '/api/admin/plugins/mdx-page-renderer';
 
     // HTTP helpers
     function postJSON(url, body) {
@@ -22,11 +22,10 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
         });
     }
 
-
     // Data loading
     // Reload settings and sources from the /api/ mirror of the admin page route.
     function loadData() {
-        $.get(API)
+        $.get(NAV_API)
             .then(function (data) {
                 populateSettings(data.settings || {});
                 renderSourceList(data.sources || []);
@@ -109,7 +108,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
 
         const pathsEl = document.getElementById('mdx-content-paths');
         if (pathsEl) {
-            $.get(API)
+            $.get(NAV_API)
                 .then(function (data) {
                     const sources = data.sources || [];
                     pathsEl.innerHTML = sources.map(function (s) {
@@ -189,7 +188,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
             var listEl = document.getElementById('mdx-inline-page-list');
             listEl.innerHTML = '<p class="text-muted">Loading...</p>';
 
-            $.get(BASE + '/inline/pages', { id: inlineEditor.sourceId })
+            $.get(API + '/inline/pages', { id: inlineEditor.sourceId })
                 .then(function (data) {
                     var pages = data.pages || [];
                     if (!pages.length) {
@@ -229,7 +228,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
             inlineEditor.pagePath = pagePath;
             document.getElementById('mdx-inline-path').value = pagePath;
 
-            $.get(BASE + '/inline/page', { id: inlineEditor.sourceId, path: pagePath })
+            $.get(API + '/inline/page', { id: inlineEditor.sourceId, path: pagePath })
                 .then(function (data) {
                     document.getElementById('mdx-inline-textarea').value = data.content || '';
                     inlineEditor.showEditPane();
@@ -260,7 +259,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
 
             resultEl.textContent = 'Saving...';
 
-            postJSON(BASE + '/inline/page', { id: inlineEditor.sourceId, path: pagePath, content: content })
+            postJSON(API + '/inline/page', { id: inlineEditor.sourceId, path: pagePath, content: content })
                 .then(function () {
                     inlineEditor.pagePath = pagePath;
                     document.getElementById('mdx-inline-path').value = pagePath;
@@ -276,7 +275,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
             if (!window.confirm('Delete ' + pagePath + '?')) return;
 
             $.ajax({
-                url: BASE + '/inline/page',
+                url: API + '/inline/page',
                 type: 'DELETE',
                 contentType: 'application/json',
                 data: JSON.stringify({ id: inlineEditor.sourceId, path: pagePath }),
@@ -385,7 +384,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
         submitBtn.disabled = true;
         submitBtn.textContent = 'Adding...';
 
-        postJSON(`${BASE}/source`, {type, label, urlPrefix, url, asset, tag})
+        postJSON(`${API}/source`, {type, label, urlPrefix, url, asset, tag})
             .then(function (res) {
                 const sourceId = res.source.id;
                 const sourceLabel = res.source.label;
@@ -406,7 +405,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
                     '</div>';
                 submitBtn.textContent = 'Downloading...';
 
-                postJSON(`${BASE}/refresh`, {id: sourceId})
+                postJSON(`${API}/refresh`, {id: sourceId})
                     .then(function (refreshRes) {
                         const r = refreshRes.report;
                         hideAddForm();
@@ -433,7 +432,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
     // Source operations
     // Patch mutable source fields; reloads on failure to revert the UI.
     function updateSource(id, data) {
-        postJSON(`${BASE}/source/update`, {id, ...data})
+        postJSON(`${API}/source/update`, {id, ...data})
             .catch(function (err) {
                 const msg = (err.responseJSON && err.responseJSON.error) || err.statusText;
                 alerts.error(`Failed to update source: ${msg}`);
@@ -446,7 +445,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
         const resultEl = document.querySelector(`.mdx-refresh-result[data-id="${id}"]`);
         if (resultEl) resultEl.textContent = 'Refreshing...';
 
-        postJSON(`${BASE}/refresh`, {id})
+        postJSON(`${API}/refresh`, {id})
             .then(function (res) {
                 const r = res.report;
                 let summary = `Added: ${r.added.length}, Updated: ${r.updated.length}, Deleted: ${r.autoDeleted.length}`;
@@ -471,7 +470,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
             },
             callback: function (confirmed) {
                 if (!confirmed) return;
-                postJSON(`${BASE}/source/remove`, {id})
+                postJSON(`${API}/source/remove`, {id})
                     .then(function () {
                         loadData();
                     })
@@ -493,7 +492,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
             data[el.name] = el.value;
         });
 
-        postJSON(`${BASE}/save`, data)
+        postJSON(`${API}/save`, data)
             .then(function () {
                 alerts.success('Settings saved.');
             })
@@ -507,7 +506,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
         const resultEl = document.getElementById('mdx-clear-cache-result');
         resultEl.textContent = 'Clearing...';
 
-        postJSON(`${BASE}/clear-cache`, {})
+        postJSON(`${API}/clear-cache`, {})
             .then(function () {
                 resultEl.textContent = 'Cache cleared. Next page load will recompile.';
             })
@@ -520,7 +519,7 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
         const resultEl = document.getElementById('mdx-export-result');
         resultEl.textContent = 'Building...';
 
-        postJSON(`${BASE}/export`, {})
+        postJSON(`${API}/export`, {})
             .then(function (res) {
                 const r = res.result;
                 let msg = `Done. Built ${r.built} page(s).`;
@@ -569,8 +568,6 @@ define('admin/plugins/mdx-page-renderer', ['alerts', 'bootbox'], function (alert
         // Delegate Refresh/Remove button clicks via the source list container.
         document.getElementById('mdx-source-list').addEventListener('click', function (e) {
             const id = e.target.dataset.id;
-            console.log(e.target);
-            console.log(id);
             if (!id) {
                 return;
             }