Merge branch 'staging' into vectors-router

.eslintrc.js

@@ -58,6 +58,7 @@ module.exports = {
         'comma-dangle': ['error', 'always-multiline'],
         'eol-last': ['error', 'always'],
         'no-trailing-spaces': 'error',
+        'object-curly-spacing': ['error', 'always'],
 
         // These rules should eventually be enabled.
         'no-async-promise-executor': 'off',

public/script.js

@@ -2914,7 +2914,7 @@ async function Generate(type, { automatic_trigger, force_name2, resolve, reject,
         let textareaText;
         if (type !== 'regenerate' && type !== 'swipe' && type !== 'quiet' && !isImpersonate && !dryRun) {
             is_send_press = true;
-            textareaText = $('#send_textarea').val();
+            textareaText = String($('#send_textarea').val());
             $('#send_textarea').val('').trigger('input');
         } else {
             textareaText = '';
@@ -2960,7 +2960,7 @@ async function Generate(type, { automatic_trigger, force_name2, resolve, reject,
         //*********************************
 
         //for normal messages sent from user..
-        if ((textareaText != '' || hasPendingFileAttachment()) && !automatic_trigger && type !== 'quiet') {
+        if ((textareaText != '' || hasPendingFileAttachment()) && !automatic_trigger && type !== 'quiet' && !dryRun) {
             // If user message contains no text other than bias - send as a system message
             if (messageBias && replaceBiasMarkup(textareaText).trim().length === 0) {
                 sendSystemMessage(system_message_types.GENERIC, ' ', { bias: messageBias });
@@ -2969,7 +2969,7 @@ async function Generate(type, { automatic_trigger, force_name2, resolve, reject,
                 await sendMessageAsUser(textareaText, messageBias);
             }
         }
-        else if (textareaText == '' && !automatic_trigger && type === undefined && main_api == 'openai' && oai_settings.send_if_empty.trim().length > 0) {
+        else if (textareaText == '' && !automatic_trigger && !dryRun && type === undefined && main_api == 'openai' && oai_settings.send_if_empty.trim().length > 0) {
             // Use send_if_empty if set and the user message is empty. Only when sending messages normally
             await sendMessageAsUser(oai_settings.send_if_empty.trim(), messageBias);
         }
@@ -4154,11 +4154,11 @@ async function DupeChar() {
         return;
     }
 
-    const confirm = await callPopup(`
+    const confirmMessage = `
     <h3>Are you sure you want to duplicate this character?</h3>
-        <span>If you just want to start a new chat with the same character, use "Start new chat" option in the bottom-left options menu.</span><br><br>`,
+    <span>If you just want to start a new chat with the same character, use "Start new chat" option in the bottom-left options menu.</span><br><br>`;
-        'confirm',
+
-    );
+    const confirm = await callPopup(confirmMessage, 'confirm');
 
     if (!confirm) {
         console.log('User cancelled duplication');
@@ -7631,10 +7631,7 @@ function doTogglePanels() {
 }
 
 function addDebugFunctions() {
-    registerDebugFunction('backfillTokenCounts', 'Backfill token counters',
+    const doBackfill = async () => {
-        `Recalculates token counts of all messages in the current chat to refresh the counters.
-        Useful when you switch between models that have different tokenizers.
-        This is a visual change only. Your chat will be reloaded.`, async () => {
         for (const message of chat) {
             // System messages are not counted
             if (message.is_system) {
@@ -7650,7 +7647,12 @@ function addDebugFunctions() {
 
         await saveChatConditional();
         await reloadCurrentChat();
-    });
+    };
+
+    registerDebugFunction('backfillTokenCounts', 'Backfill token counters',
+        `Recalculates token counts of all messages in the current chat to refresh the counters.
+        Useful when you switch between models that have different tokenizers.
+        This is a visual change only. Your chat will be reloaded.`, doBackfill);
 
     registerDebugFunction('generationTest', 'Send a generation request', 'Generates text using the currently selected API.', async () => {
         const text = prompt('Input text:', 'Hello');

public/scripts/bulk-edit.js

@@ -1,5 +1,5 @@
 import { characters, getCharacters, handleDeleteCharacter, callPopup } from '../script.js';
-import {BulkEditOverlay, BulkEditOverlayState} from './BulkEditOverlay.js';
+import { BulkEditOverlay, BulkEditOverlayState } from './BulkEditOverlay.js';
 
 
 let is_bulk_edit = false;

public/scripts/chats.js

@@ -152,7 +152,7 @@ export async function populateFileAttachment(message, inputId = 'file_form_input
  */
 export async function uploadFileAttachment(fileName, base64Data) {
     try {
-        const result = await fetch('/api/file/upload', {
+        const result = await fetch('/api/files/upload', {
             method: 'POST',
             headers: getRequestHeaders(),
             body: JSON.stringify({
@@ -302,7 +302,7 @@ async function viewMessageFile(messageId) {
     modalTemplate.addClass('file_modal');
     addCopyToCodeBlocks(modalTemplate);
 
-    callPopup(modalTemplate, 'text');
+    callPopup(modalTemplate, 'text', '', { wide: true, large: true });
 }
 
 /**

public/scripts/extensions/translate/index.js

@@ -1,4 +1,4 @@
-export {translate};
+export { translate };
 
 import {
     callPopup,

public/scripts/extensions/tts/index.js

@@ -10,7 +10,7 @@ import { NovelTtsProvider } from './novel.js';
 import { power_user } from '../../power-user.js';
 import { registerSlashCommand } from '../../slash-commands.js';
 import { OpenAITtsProvider } from './openai.js';
-import {XTTSTtsProvider} from './xtts.js';
+import { XTTSTtsProvider } from './xtts.js';
 export { talkingAnimation };
 
 const UPDATE_INTERVAL = 1000;

public/scripts/extensions/tts/novel.js

@@ -125,7 +125,7 @@ class NovelTtsProvider {
             throw 'TTS Voice name not provided';
         }
 
-        return { name: voiceName, voice_id: voiceName, lang: 'en-US', preview_url: false};
+        return { name: voiceName, voice_id: voiceName, lang: 'en-US', preview_url: false };
     }
 
     async generateTts(text, voiceId) {

public/scripts/power-user.js

@@ -666,7 +666,7 @@ async function CreateZenSliders(elmnt) {
         min: sliderMin,
         max: sliderMax,
         create: async function () {
-            await delay(100)
+            await delay(100);
             var handle = $(this).find('.ui-slider-handle');
             var handleText, stepNumber, leftMargin;
 
@@ -711,7 +711,7 @@ async function CreateZenSliders(elmnt) {
                 stepNumber = ((sliderValue - sliderMin) / stepScale);
                 leftMargin = (stepNumber / numSteps) * 50 * -1;
                 originalSlider.val(numVal)
-                    .data('newSlider', newSlider)
+                    .data('newSlider', newSlider);
                 //console.log(`${newSlider.attr('id')} sliderValue = ${sliderValue}, handleText:${handleText, numVal}, stepNum:${stepNumber}, numSteps:${numSteps}, left-margin:${leftMargin}`)
                 var isManualInput = false;
                 var valueBeforeManualInput;
@@ -737,8 +737,8 @@ async function CreateZenSliders(elmnt) {
                         isManualInput = true;
                         //allow enter to trigger slider update
                         if (e.key === 'Enter') {
-                            e.preventDefault
+                            e.preventDefault;
-                            handle.trigger('blur')
+                            handle.trigger('blur');
                         }
                     })
                     //trigger slider changes when user clicks away

server.js

@@ -3576,55 +3576,58 @@ async function fetchJSON(url, args = {}) {
 // ** END **
 
 // OpenAI API
-require('./src/endpoints/openai').registerEndpoints(app, jsonParser, urlencodedParser);
+app.use('/api/openai', require('./src/endpoints/openai').router);
 
 // Tokenizers
 require('./src/endpoints/tokenizers').registerEndpoints(app, jsonParser);
 
 // Preset management
-require('./src/endpoints/presets').registerEndpoints(app, jsonParser);
+app.use('/api/presets', require('./src/endpoints/presets').router);
 
 // Secrets managemenet
-require('./src/endpoints/secrets').registerEndpoints(app, jsonParser);
+app.use('/api/secrets', require('./src/endpoints/secrets').router);
 
-// Thumbnail generation
+// Thumbnail generation. These URLs are saved in chat, so this route cannot be renamed!
-require('./src/endpoints/thumbnails').registerEndpoints(app, jsonParser);
+app.use('/thumbnail', require('./src/endpoints/thumbnails').router);
 
 // NovelAI generation
-require('./src/endpoints/novelai').registerEndpoints(app, jsonParser);
+app.use('/api/novelai', require('./src/endpoints/novelai').router);
 
 // Third-party extensions
-require('./src/endpoints/extensions').registerEndpoints(app, jsonParser);
+app.use('/api/extensions', require('./src/endpoints/extensions').router);
 
 // Asset management
-require('./src/endpoints/assets').registerEndpoints(app, jsonParser);
+app.use('/api/assets', require('./src/endpoints/assets').router);
+
+// File management
+app.use('/api/files', require('./src/endpoints/files').router);
 
 // Character sprite management
-require('./src/endpoints/sprites').registerEndpoints(app, jsonParser, urlencodedParser);
+app.use('/api/sprites', require('./src/endpoints/sprites').router);
 
 // Custom content management
-require('./src/endpoints/content-manager').registerEndpoints(app, jsonParser);
+app.use('/api/content', require('./src/endpoints/content-manager').router);
 
 // Stable Diffusion generation
 require('./src/endpoints/stable-diffusion').registerEndpoints(app, jsonParser);
 
 // LLM and SD Horde generation
-require('./src/endpoints/horde').registerEndpoints(app, jsonParser);
+app.use('/api/horde', require('./src/endpoints/horde').router);
 
 // Vector storage DB
 app.use('/api/vector', require('./src/endpoints/vectors').router);
 
 // Chat translation
-require('./src/endpoints/translate').registerEndpoints(app, jsonParser);
+app.use('/api/translate', require('./src/endpoints/translate').router);
 
 // Emotion classification
-require('./src/endpoints/classify').registerEndpoints(app, jsonParser);
+app.use('/api/extra/classify', require('./src/endpoints/classify').router);
 
 // Image captioning
-require('./src/endpoints/caption').registerEndpoints(app, jsonParser);
+app.use('/api/extra/caption', require('./src/endpoints/caption').router);
 
 // Web search extension
-require('./src/endpoints/serpapi').registerEndpoints(app, jsonParser);
+app.use('/api/serpapi', require('./src/endpoints/serpapi').router);
 
 const tavernUrl = new URL(
     (cliArguments.ssl ? 'https://' : 'http://') +

src/endpoints/assets.js

@@ -1,10 +1,12 @@
 const path = require('path');
 const fs = require('fs');
+const express = require('express');
 const sanitize = require('sanitize-filename');
 const fetch = require('node-fetch').default;
 const { finished } = require('stream/promises');
 const writeFileSyncAtomic = require('write-file-atomic').sync;
 const { DIRECTORIES, UNSAFE_EXTENSIONS } = require('../constants');
+const { jsonParser } = require('../express-common');
 
 const VALID_CATEGORIES = ['bgm', 'ambient', 'blip', 'live2d'];
 
@@ -57,13 +59,9 @@ function getFiles(dir, files = []) {
     return files;
 }
 
+const router = express.Router();
+
 /**
- * Registers the endpoints for the asset management.
- * @param {import('express').Express} app Express app
- * @param {any} jsonParser JSON parser middleware
- */
-function registerEndpoints(app, jsonParser) {
-    /**
  * HTTP POST handler function to retrieve name of all files of a given folder path.
  *
  * @param {Object} request - HTTP Request object. Require folder path in query
@@ -71,7 +69,7 @@ function registerEndpoints(app, jsonParser) {
  *
  * @returns {void}
  */
-    app.post('/api/assets/get', jsonParser, async (_, response) => {
+router.post('/get', jsonParser, async (_, response) => {
     const folderPath = path.join(DIRECTORIES.assets);
     let output = {};
     //console.info("Checking files into",folderPath);
@@ -119,9 +117,9 @@ function registerEndpoints(app, jsonParser) {
         console.log(err);
     }
     return response.send(output);
-    });
+});
 
-    /**
+/**
  * HTTP POST handler function to download the requested asset.
  *
  * @param {Object} request - HTTP Request object, expects a url, a category and a filename.
@@ -129,7 +127,7 @@ function registerEndpoints(app, jsonParser) {
  *
  * @returns {void}
  */
-    app.post('/api/assets/download', jsonParser, async (request, response) => {
+router.post('/download', jsonParser, async (request, response) => {
     const url = request.body.url;
     const inputCategory = request.body.category;
     const inputFilename = sanitize(request.body.filename);
@@ -179,9 +177,9 @@ function registerEndpoints(app, jsonParser) {
         console.log(error);
         response.sendStatus(500);
     }
-    });
+});
 
-    /**
+/**
  * HTTP POST handler function to delete the requested asset.
  *
  * @param {Object} request - HTTP Request object, expects a category and a filename
@@ -189,7 +187,7 @@ function registerEndpoints(app, jsonParser) {
  *
  * @returns {void}
  */
-    app.post('/api/assets/delete', jsonParser, async (request, response) => {
+router.post('/delete', jsonParser, async (request, response) => {
     const inputCategory = request.body.category;
     const inputFilename = sanitize(request.body.filename);
 
@@ -231,10 +229,10 @@ function registerEndpoints(app, jsonParser) {
         console.log(error);
         response.sendStatus(500);
     }
-    });
+});
 
-    ///////////////////////////////
+///////////////////////////////
-    /**
+/**
  * HTTP POST handler function to retrieve a character background music list.
  *
  * @param {Object} request - HTTP Request object, expects a character name in the query.
@@ -242,7 +240,7 @@ function registerEndpoints(app, jsonParser) {
  *
  * @returns {void}
  */
-    app.post('/api/assets/character', jsonParser, async (request, response) => {
+router.post('/character', jsonParser, async (request, response) => {
     if (request.query.name === undefined) return response.sendStatus(400);
     const name = sanitize(request.query.name.toString());
     const inputCategory = request.query.category;
@@ -295,9 +293,9 @@ function registerEndpoints(app, jsonParser) {
         console.log(err);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/file/upload', jsonParser, async (request, response) => {
+router.post('/upload', jsonParser, async (request, response) => {
     try {
         if (!request.body.name) {
             return response.status(400).send('No upload name specified');
@@ -321,9 +319,6 @@ function registerEndpoints(app, jsonParser) {
         console.log(error);
         return response.sendStatus(500);
     }
-    });
+});
-}
 
-module.exports = {
+module.exports = { router, checkAssetFileName };
-    registerEndpoints,
-};

src/endpoints/caption.js

@@ -1,11 +1,11 @@
+const express = require('express');
+const { jsonParser } = require('../express-common');
+
 const TASK = 'image-to-text';
 
-/**
+const router = express.Router();
- * @param {import("express").Express} app
+
- * @param {any} jsonParser
+router.post('/', jsonParser, async (req, res) => {
- */
-function registerEndpoints(app, jsonParser) {
-    app.post('/api/extra/caption', jsonParser, async (req, res) => {
     try {
         const { image } = req.body;
 
@@ -27,9 +27,6 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         return res.sendStatus(500);
     }
-    });
+});
-}
 
-module.exports = {
+module.exports = { router };
-    registerEndpoints,
-};

src/endpoints/classify.js

@@ -1,13 +1,13 @@
+const express = require('express');
+const { jsonParser } = require('../express-common');
+
 const TASK = 'text-classification';
 
-/**
+const router = express.Router();
- * @param {import("express").Express} app
- * @param {any} jsonParser
- */
-function registerEndpoints(app, jsonParser) {
-    const cacheObject = {};
 
-    app.post('/api/extra/classify/labels', jsonParser, async (req, res) => {
+const cacheObject = {};
+
+router.post('/labels', jsonParser, async (req, res) => {
     try {
         const module = await import('../transformers.mjs');
         const pipe = await module.default.getPipeline(TASK);
@@ -17,9 +17,9 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         return res.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/extra/classify', jsonParser, async (req, res) => {
+router.post('/', jsonParser, async (req, res) => {
     try {
         const { text } = req.body;
 
@@ -45,9 +45,6 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         return res.sendStatus(500);
     }
-    });
+});
-}
 
-module.exports = {
+module.exports = { router };
-    registerEndpoints,
-};

src/endpoints/content-manager.js

@@ -1,8 +1,10 @@
 const fs = require('fs');
 const path = require('path');
+const express = require('express');
 const fetch = require('node-fetch').default;
 const sanitize = require('sanitize-filename');
 const { getConfigValue } = require('../util');
+const { jsonParser } = require('../express-common');
 const contentDirectory = path.join(process.cwd(), 'default/content');
 const contentLogPath = path.join(contentDirectory, 'content.log');
 const contentIndexPath = path.join(contentDirectory, 'index.json');
@@ -302,13 +304,9 @@ function parseJannyUrl(url) {
     return uuid;
 }
 
-/**
+const router = express.Router();
- * Registers endpoints for custom content management
+
- * @param {import('express').Express} app Express app
+router.post('/import', jsonParser, async (request, response) => {
- * @param {any} jsonParser JSON parser middleware
- */
-function registerEndpoints(app, jsonParser) {
-    app.post('/api/content/import', jsonParser, async (request, response) => {
     if (!request.body.url) {
         return response.sendStatus(400);
     }
@@ -352,12 +350,11 @@ function registerEndpoints(app, jsonParser) {
         console.log('Importing custom content failed', error);
         return response.sendStatus(500);
     }
-    });
+});
-}
 
 module.exports = {
     checkForNewContent,
-    registerEndpoints,
     getDefaultPresets,
     getDefaultPresetFile,
+    router,
 };

src/endpoints/extensions.js

@@ -1,8 +1,10 @@
 const path = require('path');
 const fs = require('fs');
+const express = require('express');
 const { default: simpleGit } = require('simple-git');
 const sanitize = require('sanitize-filename');
 const { DIRECTORIES } = require('../constants');
+const { jsonParser } = require('../express-common');
 
 /**
  * This function extracts the extension information from the manifest file.
@@ -45,13 +47,9 @@ async function checkIfRepoIsUpToDate(extensionPath) {
     };
 }
 
+const router = express.Router();
+
 /**
- * Registers the endpoints for the third-party extensions API.
- * @param {import('express').Express} app - Express app
- * @param {any} jsonParser - JSON parser middleware
- */
-function registerEndpoints(app, jsonParser) {
-    /**
  * HTTP POST handler function to clone a git repository from a provided URL, read the extension manifest,
  * and return extension information and path.
  *
@@ -60,7 +58,7 @@ function registerEndpoints(app, jsonParser) {
  *
  * @returns {void}
  */
-    app.post('/api/extensions/install', jsonParser, async (request, response) => {
+router.post('/install', jsonParser, async (request, response) => {
     if (!request.body.url) {
         return response.status(400).send('Bad Request: URL is required in the request body.');
     }
@@ -92,9 +90,9 @@ function registerEndpoints(app, jsonParser) {
         console.log('Importing custom content failed', error);
         return response.status(500).send(`Server Error: ${error.message}`);
     }
-    });
+});
 
-    /**
+/**
  * HTTP POST handler function to pull the latest updates from a git repository
  * based on the extension name provided in the request body. It returns the latest commit hash,
  * the path of the extension, the status of the repository (whether it's up-to-date or not),
@@ -105,7 +103,7 @@ function registerEndpoints(app, jsonParser) {
  *
  * @returns {void}
  */
-    app.post('/api/extensions/update', jsonParser, async (request, response) => {
+router.post('/update', jsonParser, async (request, response) => {
     const git = simpleGit();
     if (!request.body.extensionName) {
         return response.status(400).send('Bad Request: extensionName is required in the request body.');
@@ -138,9 +136,9 @@ function registerEndpoints(app, jsonParser) {
         console.log('Updating custom content failed', error);
         return response.status(500).send(`Server Error: ${error.message}`);
     }
-    });
+});
 
-    /**
+/**
  * HTTP POST handler function to get the current git commit hash and branch name for a given extension.
  * It checks whether the repository is up-to-date with the remote, and returns the status along with
  * the remote URL of the repository.
@@ -150,7 +148,7 @@ function registerEndpoints(app, jsonParser) {
  *
  * @returns {void}
  */
-    app.post('/api/extensions/version', jsonParser, async (request, response) => {
+router.post('/version', jsonParser, async (request, response) => {
     const git = simpleGit();
     if (!request.body.extensionName) {
         return response.status(400).send('Bad Request: extensionName is required in the request body.');
@@ -178,9 +176,9 @@ function registerEndpoints(app, jsonParser) {
         console.log('Getting extension version failed', error);
         return response.status(500).send(`Server Error: ${error.message}`);
     }
-    });
+});
 
-    /**
+/**
  * HTTP POST handler function to delete a git repository based on the extension name provided in the request body.
  *
  * @param {Object} request - HTTP Request object, expects a JSON body with a 'url' property.
@@ -188,7 +186,7 @@ function registerEndpoints(app, jsonParser) {
  *
  * @returns {void}
  */
-    app.post('/api/extensions/delete', jsonParser, async (request, response) => {
+router.post('/delete', jsonParser, async (request, response) => {
     if (!request.body.extensionName) {
         return response.status(400).send('Bad Request: extensionName is required in the request body.');
     }
@@ -212,14 +210,13 @@ function registerEndpoints(app, jsonParser) {
         console.log('Deleting custom content failed', error);
         return response.status(500).send(`Server Error: ${error.message}`);
     }
-    });
+});
 
-    /**
+/**
  * Discover the extension folders
  * If the folder is called third-party, search for subfolders instead
  */
-    app.get('/api/extensions/discover', jsonParser, function (_, response) {
+router.get('/discover', jsonParser, function (_, response) {
-
     // get all folders in the extensions folder, except third-party
     const extensions = fs
         .readdirSync(DIRECTORIES.extensions)
@@ -242,9 +239,6 @@ function registerEndpoints(app, jsonParser) {
 
 
     return response.send(extensions);
-    });
+});
-}
 
-module.exports = {
+module.exports = { router };
-    registerEndpoints,
-};

src/endpoints/files.js

@@ -0,0 +1,35 @@
+const path = require('path');
+const writeFileSyncAtomic = require('write-file-atomic').sync;
+const express = require('express');
+const router = express.Router();
+const { checkAssetFileName } = require('./assets');
+const { jsonParser } = require('../express-common');
+const { DIRECTORIES } = require('../constants');
+
+router.post('/upload', jsonParser, async (request, response) => {
+    try {
+        if (!request.body.name) {
+            return response.status(400).send('No upload name specified');
+        }
+
+        if (!request.body.data) {
+            return response.status(400).send('No upload data specified');
+        }
+
+        const safeInput = checkAssetFileName(request.body.name);
+
+        if (!safeInput) {
+            return response.status(400).send('Invalid upload name');
+        }
+
+        const pathToUpload = path.join(DIRECTORIES.files, safeInput);
+        writeFileSyncAtomic(pathToUpload, request.body.data, 'base64');
+        const url = path.normalize(pathToUpload.replace('public' + path.sep, ''));
+        return response.send({ path: url });
+    } catch (error) {
+        console.log(error);
+        return response.sendStatus(500);
+    }
+});
+
+module.exports = { router };

src/endpoints/horde.js

@@ -1,7 +1,9 @@
 const fetch = require('node-fetch').default;
+const express = require('express');
 const AIHorde = require('../ai_horde');
 const { getVersion, delay } = require('../util');
 const { readSecret, SECRET_KEYS } = require('./secrets');
+const { jsonParser } = require('../express-common');
 
 const ANONYMOUS_KEY = '0000000000';
 
@@ -52,13 +54,9 @@ function sanitizeHordeImagePrompt(prompt) {
     return prompt;
 }
 
-/**
+const router = express.Router();
- *
+
- * @param {import("express").Express} app
+router.post('/generate-text', jsonParser, async (request, response) => {
- * @param {any} jsonParser
- */
-function registerEndpoints(app, jsonParser) {
-    app.post('/api/horde/generate-text', jsonParser, async (request, response) => {
     const api_key_horde = readSecret(SECRET_KEYS.HORDE) || ANONYMOUS_KEY;
     const url = 'https://horde.koboldai.net/api/v2/generate/text/async';
 
@@ -86,9 +84,9 @@ function registerEndpoints(app, jsonParser) {
         console.log(error);
         return response.send({ error: true });
     }
-    });
+});
 
-    app.post('/api/horde/sd-samplers', jsonParser, async (_, response) => {
+router.post('/sd-samplers', jsonParser, async (_, response) => {
     try {
         const ai_horde = await getHordeClient();
         const samplers = Object.values(ai_horde.ModelGenerationInputStableSamplers);
@@ -97,9 +95,9 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/horde/sd-models', jsonParser, async (_, response) => {
+router.post('/sd-models', jsonParser, async (_, response) => {
     try {
         const ai_horde = await getHordeClient();
         const models = await ai_horde.getModels();
@@ -108,9 +106,9 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/horde/caption-image', jsonParser, async (request, response) => {
+router.post('/caption-image', jsonParser, async (request, response) => {
     try {
         const api_key_horde = readSecret(SECRET_KEYS.HORDE) || ANONYMOUS_KEY;
         const ai_horde = await getHordeClient();
@@ -160,9 +158,9 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/horde/user-info', jsonParser, async (_, response) => {
+router.post('/user-info', jsonParser, async (_, response) => {
     const api_key_horde = readSecret(SECRET_KEYS.HORDE);
 
     if (!api_key_horde) {
@@ -177,9 +175,9 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/horde/generate-image', jsonParser, async (request, response) => {
+router.post('/generate-image', jsonParser, async (request, response) => {
     if (!request.body.prompt) {
         return response.sendStatus(400);
     }
@@ -264,9 +262,6 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         return response.sendStatus(500);
     }
-    });
+});
-}
 
-module.exports = {
+module.exports = { router };
-    registerEndpoints,
-};

src/endpoints/novelai.js

@@ -1,8 +1,10 @@
 const fetch = require('node-fetch').default;
+const express = require('express');
 const util = require('util');
 const { Readable } = require('stream');
 const { readSecret, SECRET_KEYS } = require('./secrets');
 const { readAllChunks, extractFileFromZipBuffer } = require('../util');
+const { jsonParser } = require('../express-common');
 
 const API_NOVELAI = 'https://api.novelai.net';
 
@@ -60,13 +62,9 @@ function getBadWordsList(model) {
     return list.slice();
 }
 
-/**
+const router = express.Router();
- * Registers NovelAI API endpoints.
+
- * @param {import('express').Express} app - Express app
+router.post('/status', jsonParser, async function (req, res) {
- * @param {any} jsonParser - JSON parser middleware
- */
-function registerEndpoints(app, jsonParser) {
-    app.post('/api/novelai/status', jsonParser, async function (req, res) {
     if (!req.body) return res.sendStatus(400);
     const api_key_novel = readSecret(SECRET_KEYS.NOVEL);
 
@@ -98,9 +96,9 @@ function registerEndpoints(app, jsonParser) {
         console.log(error);
         return res.send({ error: true });
     }
-    });
+});
 
-    app.post('/api/novelai/generate', jsonParser, async function (req, res) {
+router.post('/generate', jsonParser, async function (req, res) {
     if (!req.body) return res.sendStatus(400);
 
     const api_key_novel = readSecret(SECRET_KEYS.NOVEL);
@@ -225,9 +223,9 @@ function registerEndpoints(app, jsonParser) {
     } catch (error) {
         return res.send({ error: true });
     }
-    });
+});
 
-    app.post('/api/novelai/generate-image', jsonParser, async (request, response) => {
+router.post('/generate-image', jsonParser, async (request, response) => {
     if (!request.body) {
         return response.sendStatus(400);
     }
@@ -323,9 +321,9 @@ function registerEndpoints(app, jsonParser) {
         console.log(error);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/novelai/generate-voice', jsonParser, async (request, response) => {
+router.post('/generate-voice', jsonParser, async (request, response) => {
     const token = readSecret(SECRET_KEYS.NOVEL);
 
     if (!token) {
@@ -363,9 +361,6 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         return response.sendStatus(500);
     }
-    });
+});
-}
 
-module.exports = {
+module.exports = { router };
-    registerEndpoints,
-};

src/endpoints/openai.js

@@ -1,16 +1,13 @@
 const { readSecret, SECRET_KEYS } = require('./secrets');
 const fetch = require('node-fetch').default;
+const express = require('express');
 const FormData = require('form-data');
 const fs = require('fs');
+const { jsonParser, urlencodedParser } = require('../express-common');
 
-/**
+const router = express.Router();
- * Registers the OpenAI endpoints.
+
- * @param {import("express").Express} app Express app
+router.post('/caption-image', jsonParser, async (request, response) => {
- * @param {any} jsonParser JSON parser
- * @param {any} urlencodedParser Form data parser
- */
-function registerEndpoints(app, jsonParser, urlencodedParser) {
-    app.post('/api/openai/caption-image', jsonParser, async (request, response) => {
     try {
         let key = '';
 
@@ -86,9 +83,9 @@ function registerEndpoints(app, jsonParser, urlencodedParser) {
         console.error(error);
         response.status(500).send('Internal server error');
     }
-    });
+});
 
-    app.post('/api/openai/transcribe-audio', urlencodedParser, async (request, response) => {
+router.post('/transcribe-audio', urlencodedParser, async (request, response) => {
     try {
         const key = readSecret(SECRET_KEYS.OPENAI);
 
@@ -134,9 +131,9 @@ function registerEndpoints(app, jsonParser, urlencodedParser) {
         console.error('OpenAI transcription failed', error);
         response.status(500).send('Internal server error');
     }
-    });
+});
 
-    app.post('/api/openai/generate-voice', jsonParser, async (request, response) => {
+router.post('/generate-voice', jsonParser, async (request, response) => {
     try {
         const key = readSecret(SECRET_KEYS.OPENAI);
 
@@ -173,9 +170,9 @@ function registerEndpoints(app, jsonParser, urlencodedParser) {
         console.error('OpenAI TTS generation failed', error);
         response.status(500).send('Internal server error');
     }
-    });
+});
 
-    app.post('/api/openai/generate-image', jsonParser, async (request, response) => {
+router.post('/generate-image', jsonParser, async (request, response) => {
     try {
         const key = readSecret(SECRET_KEYS.OPENAI);
 
@@ -208,9 +205,6 @@ function registerEndpoints(app, jsonParser, urlencodedParser) {
         console.error(error);
         response.status(500).send('Internal server error');
     }
-    });
+});
-}
 
-module.exports = {
+module.exports = { router };
-    registerEndpoints,
-};

src/endpoints/presets.js

@@ -1,9 +1,11 @@
 const fs = require('fs');
 const path = require('path');
+const express = require('express');
 const sanitize = require('sanitize-filename');
 const writeFileAtomicSync = require('write-file-atomic').sync;
 const { DIRECTORIES } = require('../constants');
 const { getDefaultPresetFile, getDefaultPresets } = require('./content-manager');
+const { jsonParser } = require('../express-common');
 
 /**
  * Gets the folder and extension for the preset settings based on the API source ID.
@@ -30,13 +32,9 @@ function getPresetSettingsByAPI(apiId) {
     }
 }
 
-/**
+const router = express.Router();
- * Registers the preset management endpoints.
+
- * @param {import('express').Express} app Express app
+router.post('/save', jsonParser, function (request, response) {
- * @param {any} jsonParser JSON parser middleware
- */
-function registerEndpoints(app, jsonParser) {
-    app.post('/api/presets/save', jsonParser, function (request, response) {
     const name = sanitize(request.body.name);
     if (!request.body.preset || !name) {
         return response.sendStatus(400);
@@ -52,9 +50,9 @@ function registerEndpoints(app, jsonParser) {
     const fullpath = path.join(settings.folder, filename);
     writeFileAtomicSync(fullpath, JSON.stringify(request.body.preset, null, 4), 'utf-8');
     return response.send({ name });
-    });
+});
 
-    app.post('/api/presets/delete', jsonParser, function (request, response) {
+router.post('/delete', jsonParser, function (request, response) {
     const name = sanitize(request.body.name);
     if (!name) {
         return response.sendStatus(400);
@@ -75,9 +73,9 @@ function registerEndpoints(app, jsonParser) {
     } else {
         return response.sendStatus(404);
     }
-    });
+});
 
-    app.post('/api/presets/restore', jsonParser, function (request, response) {
+router.post('/restore', jsonParser, function (request, response) {
     try {
         const settings = getPresetSettingsByAPI(request.body.apiId);
         const name = sanitize(request.body.name);
@@ -97,10 +95,10 @@ function registerEndpoints(app, jsonParser) {
         console.log(error);
         return response.sendStatus(500);
     }
-    });
+});
 
-    // TODO: Merge with /api/presets/save
+// TODO: Merge with /api/presets/save
-    app.post('/api/presets/save-openai', jsonParser, function (request, response) {
+router.post('/save-openai', jsonParser, function (request, response) {
     if (!request.body || typeof request.query.name !== 'string') return response.sendStatus(400);
     const name = sanitize(request.query.name);
     if (!name) return response.sendStatus(400);
@@ -109,10 +107,10 @@ function registerEndpoints(app, jsonParser) {
     const fullpath = path.join(DIRECTORIES.openAI_Settings, filename);
     writeFileAtomicSync(fullpath, JSON.stringify(request.body, null, 4), 'utf-8');
     return response.send({ name });
-    });
+});
 
-    // TODO: Merge with /api/presets/delete
+// TODO: Merge with /api/presets/delete
-    app.post('/api/presets/delete-openai', jsonParser, function (request, response) {
+router.post('/delete-openai', jsonParser, function (request, response) {
     if (!request.body || !request.body.name) {
         return response.sendStatus(400);
     }
@@ -126,9 +124,6 @@ function registerEndpoints(app, jsonParser) {
     }
 
     return response.send({ error: true });
-    });
+});
-}
 
-module.exports = {
+module.exports = { router };
-    registerEndpoints,
-};

src/endpoints/secrets.js

@@ -1,7 +1,9 @@
 const fs = require('fs');
 const path = require('path');
+const express = require('express');
 const { getConfigValue } = require('../util');
 const writeFileAtomicSync = require('write-file-atomic').sync;
+const { jsonParser } = require('../express-common');
 
 const SECRETS_FILE = path.join(process.cwd(), './secrets.json');
 const SECRET_KEYS = {
@@ -143,23 +145,17 @@ function getAllSecrets() {
     return secrets;
 }
 
-/**
+const router = express.Router();
- * Registers endpoints for the secret management API
- * @param {import('express').Express} app Express app
- * @param {any} jsonParser JSON parser middleware
- */
-function registerEndpoints(app, jsonParser) {
 
-    app.post('/api/secrets/write', jsonParser, (request, response) => {
+router.post('/write', jsonParser, (request, response) => {
     const key = request.body.key;
     const value = request.body.value;
 
     writeSecret(key, value);
     return response.send('ok');
-    });
+});
-
-    app.post('/api/secrets/read', jsonParser, (_, response) => {
 
+router.post('/read', jsonParser, (_, response) => {
     try {
         const state = readSecretState();
         return response.send(state);
@@ -167,9 +163,9 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         return response.send({});
     }
-    });
+});
 
-    app.post('/api/secrets/view', jsonParser, async (_, response) => {
+router.post('/view', jsonParser, async (_, response) => {
     const allowKeysExposure = getConfigValue('allowKeysExposure', false);
 
     if (!allowKeysExposure) {
@@ -189,9 +185,9 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/secrets/find', jsonParser, (request, response) => {
+router.post('/find', jsonParser, (request, response) => {
     const allowKeysExposure = getConfigValue('allowKeysExposure', false);
 
     if (!allowKeysExposure) {
@@ -213,8 +209,7 @@ function registerEndpoints(app, jsonParser) {
         console.error(error);
         return response.sendStatus(500);
     }
-    });
+});
-}
 
 module.exports = {
     writeSecret,
@@ -222,6 +217,6 @@ module.exports = {
     readSecretState,
     migrateSecrets,
     getAllSecrets,
-    registerEndpoints,
     SECRET_KEYS,
+    router,
 };

src/endpoints/serpapi.js

@@ -1,13 +1,11 @@
 const fetch = require('node-fetch').default;
+const express = require('express');
 const { readSecret, SECRET_KEYS } = require('./secrets');
+const { jsonParser } = require('../express-common');
 
-/**
+const router = express.Router();
- * Registers the SerpApi endpoints.
+
- * @param {import("express").Express} app
+router.post('/search', jsonParser, async (request, response) => {
- * @param {any} jsonParser
- */
-function registerEndpoints(app, jsonParser) {
-    app.post('/api/serpapi/search', jsonParser, async (request, response) => {
     try {
         const key = readSecret(SECRET_KEYS.SERPAPI);
 
@@ -31,9 +29,6 @@ function registerEndpoints(app, jsonParser) {
         console.log(error);
         return response.sendStatus(500);
     }
-    });
+});
-}
 
-module.exports = {
+module.exports = { router };
-    registerEndpoints,
-};

src/endpoints/sprites.js

@@ -1,11 +1,13 @@
 
 const fs = require('fs');
 const path = require('path');
+const express = require('express');
 const mime = require('mime-types');
 const sanitize = require('sanitize-filename');
 const writeFileAtomicSync = require('write-file-atomic').sync;
 const { DIRECTORIES, UPLOADS_PATH } = require('../constants');
 const { getImageBuffers } = require('../util');
+const { jsonParser, urlencodedParser } = require('../express-common');
 
 /**
  * Gets the path to the sprites folder for the provided character name
@@ -101,14 +103,9 @@ function importRisuSprites(data) {
     }
 }
 
-/**
+const router = express.Router();
- * Registers the endpoints for the sprite management.
+
- * @param {import('express').Express} app Express app
+router.get('/get', jsonParser, function (request, response) {
- * @param {any} jsonParser JSON parser middleware
- * @param {any} urlencodedParser URL encoded parser middleware
- */
-function registerEndpoints(app, jsonParser, urlencodedParser) {
-    app.get('/api/sprites/get', jsonParser, function (request, response) {
     const name = String(request.query.name);
     const isSubfolder = name.includes('/');
     const spritesPath = getSpritesPath(name, isSubfolder);
@@ -134,9 +131,9 @@ function registerEndpoints(app, jsonParser, urlencodedParser) {
         console.log(err);
     }
     return response.send(sprites);
-    });
+});
 
-    app.post('/api/sprites/delete', jsonParser, async (request, response) => {
+router.post('/delete', jsonParser, async (request, response) => {
     const label = request.body.label;
     const name = request.body.name;
 
@@ -166,9 +163,9 @@ function registerEndpoints(app, jsonParser, urlencodedParser) {
         console.error(error);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/sprites/upload-zip', urlencodedParser, async (request, response) => {
+router.post('/upload-zip', urlencodedParser, async (request, response) => {
     const file = request.file;
     const name = request.body.name;
 
@@ -213,9 +210,9 @@ function registerEndpoints(app, jsonParser, urlencodedParser) {
         console.error(error);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/sprites/upload', urlencodedParser, async (request, response) => {
+router.post('/upload', urlencodedParser, async (request, response) => {
     const file = request.file;
     const label = request.body.label;
     const name = request.body.name;
@@ -258,10 +255,9 @@ function registerEndpoints(app, jsonParser, urlencodedParser) {
         console.error(error);
         return response.sendStatus(500);
     }
-    });
+});
-}
 
 module.exports = {
-    registerEndpoints,
+    router,
     importRisuSprites,
 };

src/endpoints/thumbnails.js

@@ -1,10 +1,12 @@
 const fs = require('fs');
 const path = require('path');
+const express = require('express');
 const sanitize = require('sanitize-filename');
 const jimp = require('jimp');
 const writeFileAtomicSync = require('write-file-atomic').sync;
 const { DIRECTORIES } = require('../constants');
 const { getConfigValue } = require('../util');
+const { jsonParser } = require('../express-common');
 
 /**
  * Gets a path to thumbnail folder based on the type.
@@ -150,15 +152,10 @@ async function ensureThumbnailCache() {
     console.log(`Done! Generated: ${bgFiles.length} preview images`);
 }
 
+const router = express.Router();
 
-/**
+// Important: This route must be mounted as '/thumbnail'. It is used in the client code and saved to chat files.
- * Registers the endpoints for the thumbnail management.
+router.get('/', jsonParser, async function (request, response) {
- * @param {import('express').Express} app Express app
- * @param {any} jsonParser JSON parser middleware
- */
-function registerEndpoints(app, jsonParser) {
-    // Important: Do not change a path to this endpoint. It is used in the client code and saved to chat files.
-    app.get('/thumbnail', jsonParser, async function (request, response) {
     if (typeof request.query.file !== 'string' || typeof request.query.type !== 'string') return response.sendStatus(400);
 
     const type = request.query.type;
@@ -191,12 +188,10 @@ function registerEndpoints(app, jsonParser) {
     }
 
     return response.sendFile(pathToCachedFile, { root: process.cwd() });
-    });
+});
-
-}
 
 module.exports = {
     invalidateThumbnail,
-    registerEndpoints,
     ensureThumbnailCache,
+    router,
 };

src/endpoints/translate.js

@@ -1,17 +1,16 @@
 const fetch = require('node-fetch').default;
 const https = require('https');
+const express = require('express');
 const { readSecret, SECRET_KEYS } = require('./secrets');
 const { getConfigValue } = require('../util');
+const { jsonParser } = require('../express-common');
 
 const DEEPLX_URL_DEFAULT = 'http://127.0.0.1:1188/translate';
 const ONERING_URL_DEFAULT = 'http://127.0.0.1:4990/translate';
 
-/**
+const router = express.Router();
- * @param {import("express").Express} app
+
- * @param {any} jsonParser
+router.post('/libre', jsonParser, async (request, response) => {
- */
-function registerEndpoints(app, jsonParser) {
-    app.post('/api/translate/libre', jsonParser, async (request, response) => {
     const key = readSecret(SECRET_KEYS.LIBRE);
     const url = readSecret(SECRET_KEYS.LIBRE_URL);
 
@@ -56,9 +55,9 @@ function registerEndpoints(app, jsonParser) {
         console.log('Translation error: ' + error.message);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/translate/google', jsonParser, async (request, response) => {
+router.post('/google', jsonParser, async (request, response) => {
     try {
         const { generateRequestUrl, normaliseResponse } = require('google-translate-api-browser');
         const text = request.body.text;
@@ -97,9 +96,9 @@ function registerEndpoints(app, jsonParser) {
         console.log('Translation error', error);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/translate/deepl', jsonParser, async (request, response) => {
+router.post('/deepl', jsonParser, async (request, response) => {
     const key = readSecret(SECRET_KEYS.DEEPL);
 
     if (!key) {
@@ -151,9 +150,9 @@ function registerEndpoints(app, jsonParser) {
         console.log('Translation error: ' + error.message);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/translate/onering', jsonParser, async (request, response) => {
+router.post('/onering', jsonParser, async (request, response) => {
     const secretUrl = readSecret(SECRET_KEYS.ONERING_URL);
     const url = secretUrl || ONERING_URL_DEFAULT;
 
@@ -204,9 +203,9 @@ function registerEndpoints(app, jsonParser) {
         console.log('Translation error: ' + error.message);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/translate/deeplx', jsonParser, async (request, response) => {
+router.post('/deeplx', jsonParser, async (request, response) => {
     const secretUrl = readSecret(SECRET_KEYS.DEEPLX_URL);
     const url = secretUrl || DEEPLX_URL_DEFAULT;
 
@@ -260,9 +259,9 @@ function registerEndpoints(app, jsonParser) {
         console.log('DeepLX translation error: ' + error.message);
         return response.sendStatus(500);
     }
-    });
+});
 
-    app.post('/api/translate/bing', jsonParser, async (request, response) => {
+router.post('/bing', jsonParser, async (request, response) => {
     const bingTranslateApi = require('bing-translate-api');
     const text = request.body.text;
     let lang = request.body.lang;
@@ -284,9 +283,6 @@ function registerEndpoints(app, jsonParser) {
         console.log('Translation error: ' + err.message);
         return response.sendStatus(500);
     });
-    });
+});
-}
 
-module.exports = {
+module.exports = { router };
-    registerEndpoints,
-};