Merge branch 'staging' into extensions-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>`,
-        'confirm',
-    );
+    <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>`;
+
+    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',
-        `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 () => {
+    const doBackfill = 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
-                            handle.trigger('blur')
+                            e.preventDefault;
+                            handle.trigger('blur');
                         }
                     })
                     //trigger slider changes when user clicks away

server.js

@@ -3597,13 +3597,16 @@ require('./src/endpoints/novelai').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);
 
 // 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);
@@ -3618,10 +3621,10 @@ require('./src/endpoints/vectors').registerEndpoints(app, jsonParser);
 require('./src/endpoints/translate').registerEndpoints(app, jsonParser);
 
 // 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);

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 = {
-    registerEndpoints,
-};
+module.exports = { router, checkAssetFileName };

src/endpoints/caption.js

@@ -1,11 +1,11 @@
+const express = require('express');
+const { jsonParser } = require('../express-common');
+
 const TASK = 'image-to-text';
 
-/**
- * @param {import("express").Express} app
- * @param {any} jsonParser
- */
-function registerEndpoints(app, jsonParser) {
-    app.post('/api/extra/caption', jsonParser, async (req, res) => {
+const router = express.Router();
+
+router.post('/', 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 = {
-    registerEndpoints,
-};
+module.exports = { router };

src/endpoints/classify.js

@@ -1,13 +1,13 @@
+const express = require('express');
+const { jsonParser } = require('../express-common');
+
 const TASK = 'text-classification';
 
-/**
- * @param {import("express").Express} app
- * @param {any} jsonParser
- */
-function registerEndpoints(app, jsonParser) {
-    const cacheObject = {};
+const router = express.Router();
 
-    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 = {
-    registerEndpoints,
-};
+module.exports = { router };

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;
 }
 
-/**
- * Registers endpoints for custom content management
- * @param {import('express').Express} app Express app
- * @param {any} jsonParser JSON parser middleware
- */
-function registerEndpoints(app, jsonParser) {
-    app.post('/api/content/import', jsonParser, async (request, response) => {
+const router = express.Router();
+
+router.post('/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/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 };