1616e7e0 · permissionBRICK/SillyTavern

src/additional-headers.js+14 -14 Viewed

 /**
  * Gets the headers for the Mancer API.
  * @param {import('./users.js').UserDirectoryList} directories User directories
  * @returns {object} Headers for the request
  */
 function getMancerHeaders(directories) {

 /**
  * Gets the headers for the TogetherAI API.
  * @param {import('./users.js').UserDirectoryList} directories User directories
  * @returns {object} Headers for the request
  */
 function getTogetherAIHeaders(directories) {

 /**
  * Gets the headers for the InfermaticAI API.
  * @param {import('./users.js').UserDirectoryList} directories User directories
  * @returns {object} Headers for the request
  */
 function getInfermaticAIHeaders(directories) {

 /**
  * Gets the headers for the DreamGen API.
  * @param {import('./users.js').UserDirectoryList} directories User directories
  * @returns {object} Headers for the request
  */
 function getDreamGenHeaders(directories) {

 /**
  * Gets the headers for the OpenRouter API.
  * @param {import('./users.js').UserDirectoryList} directories User directories
  * @returns {object} Headers for the request
  */
 function getOpenRouterHeaders(directories) {

 /**
  * Gets the headers for the vLLM API.
  * @param {import('./users.js').UserDirectoryList} directories User directories
  * @returns {object} Headers for the request
  */
 function getVllmHeaders(directories) {

 /**
  * Gets the headers for the Aphrodite API.
  * @param {import('./users.js').UserDirectoryList} directories User directories
  * @returns {object} Headers for the request
  */
 function getAphroditeHeaders(directories) {

 /**
  * Gets the headers for the Tabby API.
  * @param {import('./users.js').UserDirectoryList} directories User directories
  * @returns {object} Headers for the request
  */
 function getTabbyHeaders(directories) {

 /**
  * Gets the headers for the LlamaCPP API.
  * @param {import('./users.js').UserDirectoryList} directories User directories
  * @returns {object} Headers for the request
  */
 function getLlamaCppHeaders(directories) {

 /**
  * Gets the headers for the Ooba API.
  * @param {import('./users.js').UserDirectoryList} directories
  * @returns {object} Headers for the request
  */
 function getOobaHeaders(directories) {

 /**
  * Gets the headers for the KoboldCpp API.
  * @param {import('./users.js').UserDirectoryList} directories
  * @returns {object} Headers for the request
  */
 function getKoboldCppHeaders(directories) {

 /**
  * Gets the headers for the Featherless API.
  * @param {import('./users.js').UserDirectoryList} directories
  * @returns {object} Headers for the request
  */
 function getFeatherlessHeaders(directories) {

 /**
  * Gets the headers for the HuggingFace API.
  * @param {import('./users.js').UserDirectoryList} directories
  * @returns {object} Headers for the request
  */
 function getHuggingFaceHeaders(directories) {

  * @param {object} requestHeaders Request headers
  * @param {string} type API type
  * @param {string|null} server API server for new request
  * @param {import('./users.js').UserDirectoryList} directories User directories
  */
 export function setAdditionalHeadersByType(requestHeaders, type, server, directories) {
     const headerGetters = {

src/character-card-parser.js+1 -0 Viewed

 import fs from 'node:fs';
 +import { Buffer } from 'node:buffer';
 import encode from 'png-chunks-encode';
 import extract from 'png-chunks-extract';

src/constants.js+2 -2 Viewed

 export const SETTINGS_FILE = 'settings.json';
 /**
  * @type {import('./users.js').UserDirectoryList}
  * @readonly
  * @enum {string}
  */

 });
 /**
  * @type {import('./users.js').User}
  * @readonly
  */
 export const DEFAULT_USER = Object.freeze({

src/endpoints/assets.js+1 -1 Viewed

 /**
  * Ensure that the asset folders exist.
  * @param {import('../users.js').UserDirectoryList} directories - The user's directories
  */
 function ensureFoldersExist(directories) {
     const folderPath = path.join(directories.assets);

src/endpoints/characters.js+6 -5 Viewed

 import * as fs from 'node:fs';
 import { promises as fsPromises } from 'node:fs';
 import * as readline from 'node:readline';
 +import { Buffer } from 'node:buffer';
 import express from 'express';
 import sanitize from 'sanitize-filename';

  * processCharacter - Process a given character, read its data and calculate its statistics.
+ *
  * @param  {string} item The name of the character.
  * @param  {import('../users.js').UserDirectoryList} directories User directories
  * @return {Promise<object>}     A Promise that resolves when the character processing is done.
  */
 const processCharacter = async (item, directories) => {

 /**
  * Convert a character object to Spec V2 format.
  * @param {object} jsonObject Character object
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {boolean} hoistDate Will set the chat and create_date fields to the current date if they are missing
  * @returns {object} Character object in Spec V2 format
  */

 /**
  * Convert a character object to Spec V2 format.
  * @param {object} char Character object
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @returns {object} Character object in Spec V2 format
  */
 function convertToV2(char, directories) {

 /**
  * Format character data to Spec V2 format.
  * @param {object} data Character data
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @returns
  */
 function charaFormatData(data, directories) {

 /**
  * Gets the name for the uploaded PNG file.
  * @param {string} file File name
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @returns {string} - The name for the uploaded PNG file
  */
 function getPngName(file, directories) {

src/endpoints/content-manager.js+5 -4 Viewed

 import * as fs from 'node:fs';
 import * as path from 'node:path';
 +import { Buffer } from 'node:buffer';
 import express from 'express';
 import fetch from 'node-fetch';

 /**
  * Gets the default presets from the content directory.
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @returns {object[]} Array of default presets
  */
 export function getDefaultPresets(directories) {

 /**
  * Seeds content for a user.
  * @param {ContentItem[]} contentIndex Content index
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {string[]} forceCategories List of categories to force check (even if content check is skipped)
  * @returns {Promise<boolean>} Whether any content was added
  */

 /**
  * Checks for new content and seeds it for all users.
  * @param {import('../users.js').UserDirectoryList[]} directoriesList List of user directories
  * @param {string[]} forceCategories List of categories to force check (even if content check is skipped)
  * @returns {Promise<void>}
  */

 /**
  * Gets the target directory for the specified asset type.
  * @param {ContentType} type Asset type
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @returns {string | null} Target directory
  */
 function getTargetByType(type, directories) {

src/endpoints/images.js+1 -0 Viewed

 import * as fs from 'node:fs';
 import * as path from 'node:path';
 +import { Buffer } from 'node:buffer';
 import express from 'express';
 import sanitize from 'sanitize-filename';

src/endpoints/novelai.js+1 -0 Viewed

 import * as util from 'node:util';
 +import { Buffer } from 'node:buffer';
 import fetch from 'node-fetch';
 import express from 'express';

src/endpoints/openai.js+1 -0 Viewed

 import * as fs from 'node:fs';
 +import { Buffer } from 'node:buffer';
 import fetch from 'node-fetch';
 import FormData from 'form-data';

src/endpoints/presets.js+1 -1 Viewed

 /**
  * Gets the folder and extension for the preset settings based on the API source ID.
  * @param {string} apiId API source ID
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @returns {object} Object containing the folder and extension for the preset settings
  */
 function getPresetSettingsByAPI(apiId, directories) {

src/endpoints/secrets.js+5 -5 Viewed

 /**
  * Writes a secret to the secrets file
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {string} key Secret key
  * @param {string} value Secret value
  */

 /**
  * Deletes a secret from the secrets file
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {string} key Secret key
  * @returns
  */

 /**
  * Reads a secret from the secrets file
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {string} key Secret key
  * @returns {string} Secret value
  */

 /**
  * Reads the secret state from the secrets file
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @returns {object} Secret state
  */
 export function readSecretState(directories) {

 /**
  * Reads all secrets from the secrets file
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @returns {Record<string, string> | undefined} Secrets
  */
 export function getAllSecrets(directories) {

src/endpoints/speech.js+1 -0 Viewed

 +import { Buffer } from 'node:buffer';
 import express from 'express';
 import wavefile from 'wavefile';
 import { jsonParser } from '../express-common.js';

src/endpoints/sprites.js+2 -2 Viewed

 /**
  * Gets the path to the sprites folder for the provided character name
  * @param {import('../users.js').UserDirectoryList} directories - User directories
  * @param {string} name - The name of the character
  * @param {boolean} isSubfolder - Whether the name contains a subfolder
  * @returns {string | null} The path to the sprites folder. Null if the name is invalid.

  * Imports base64 encoded sprites from RisuAI character data.
  * The sprites are saved in the character's sprites folder.
  * The additionalAssets and emotions are removed from the data.
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {object} data RisuAI character data
  * @returns {void}
  */

src/endpoints/thumbnails.js+4 -4 Viewed

 /**
  * Gets a path to thumbnail folder based on the type.
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {'bg' | 'avatar'} type Thumbnail type
  * @returns {string} Path to the thumbnails folder
  */

 /**
  * Gets a path to the original images folder based on the type.
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {'bg' | 'avatar'} type Thumbnail type
  * @returns {string} Path to the original images folder
  */

 /**
  * Removes the generated thumbnail from the disk.
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {'bg' | 'avatar'} type Type of the thumbnail
  * @param {string} file Name of the file
  */

 /**
  * Generates a thumbnail for the given file.
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {'bg' | 'avatar'} type Type of the thumbnail
  * @param {string} file Name of the file
  * @returns

src/endpoints/tokenizers.js+1 -0 Viewed

 import * as fs from 'node:fs';
 import * as path from 'node:path';
 +import { Buffer } from 'node:buffer';
 import express from 'express';
 import { sync as writeFileAtomicSync } from 'write-file-atomic';

src/endpoints/translate.js+2 -0 Viewed

 import * as https from 'node:https';
 import { createRequire } from 'node:module';
 +import { Buffer } from 'node:buffer';
++
 import fetch from 'node-fetch';
 import express from 'express';
 import iconv from 'iconv-lite';

src/endpoints/users-admin.js+6 -6 Viewed

 router.post('/get', requireAdminMiddleware, jsonParser, async (_request, response) => {
     try {
         /** @type {import('../users.js').User[]} */
         const users = await storage.values(x => x.key.startsWith(KEY_PREFIX));
         /** @type {Promise<import('../users.js').UserViewModel>[]} */
         const viewModelPromises = users
             .map(user => new Promise(resolve => {
                 getUserAvatar(user.handle).then(avatar =>

             return response.status(400).json({ error: 'Cannot disable yourself' });
+        }
         /** @type {import('../users.js').User} */
         const user = await storage.getItem(toKey(request.body.handle));
         if (!user) {

             return response.status(400).json({ error: 'Missing required fields' });
+        }
         /** @type {import('../users.js').User} */
         const user = await storage.getItem(toKey(request.body.handle));
         if (!user) {

             return response.status(400).json({ error: 'Missing required fields' });
+        }
         /** @type {import('../users.js').User} */
         const user = await storage.getItem(toKey(request.body.handle));
         if (!user) {

             return response.status(400).json({ error: 'Cannot demote yourself' });
+        }
         /** @type {import('../users.js').User} */
         const user = await storage.getItem(toKey(request.body.handle));
         if (!user) {

src/endpoints/users-private.js+3 -3 Viewed

             return response.status(400).json({ error: 'Invalid data URL' });
+        }
         /** @type {import('../users.js').User} */
         const user = await storage.getItem(toKey(request.body.handle));
         if (!user) {

             return response.status(403).json({ error: 'Unauthorized' });
+        }
         /** @type {import('../users.js').User} */
         const user = await storage.getItem(toKey(request.body.handle));
         if (!user) {

             return response.status(403).json({ error: 'Unauthorized' });
+        }
         /** @type {import('../users.js').User} */
         const user = await storage.getItem(toKey(request.body.handle));
         if (!user) {

src/endpoints/users-public.js+5 -5 Viewed

             return response.sendStatus(204);
+        }
         /** @type {import('../users.js').User[]} */
         const users = await storage.values(x => x.key.startsWith(KEY_PREFIX));
         /** @type {Promise<import('../users.js').UserViewModel>[]} */
         const viewModelPromises = users
             .filter(x => x.enabled)
             .map(user => new Promise(async (resolve) => {

         const ip = getIpFromRequest(request);
         await loginLimiter.consume(ip);
         /** @type {import('../users.js').User} */
         const user = await storage.getItem(toKey(request.body.handle));
         if (!user) {

         const ip = getIpFromRequest(request);
         await recoverLimiter.consume(ip);
         /** @type {import('../users.js').User} */
         const user = await storage.getItem(toKey(request.body.handle));
         if (!user) {

             return response.status(400).json({ error: 'Missing required fields' });
+        }
         /** @type {import('../users.js').User} */
         const user = await storage.getItem(toKey(request.body.handle));
         const ip = getIpFromRequest(request);

src/endpoints/vectors.js+8 -8 Viewed

  * @param {Object} sourceSettings - Settings for the source, if it needs any
  * @param {string} text - The text to get the vector for
  * @param {boolean} isQuery - If the text is a query for embedding search
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[]>} - The vector for the text
  */
 async function getVector(source, sourceSettings, text, isQuery, directories) {

  * @param {Object} sourceSettings - Settings for the source, if it needs any
  * @param {string[]} texts - The array of texts to get the vector for
  * @param {boolean} isQuery - If the text is a query for embedding search
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[][]>} - The array of vectors for the texts
  */
 async function getBatchVector(source, sourceSettings, texts, isQuery, directories) {

 /**
  * Gets the index for the vector collection
  * @param {import('../users.js').UserDirectoryList} directories - User directories
  * @param {string} collectionId - The collection ID
  * @param {string} source - The source of the vector
  * @param {object} sourceSettings - The model for the source

 /**
  * Inserts items into the vector collection
  * @param {import('../users.js').UserDirectoryList} directories - User directories
  * @param {string} collectionId - The collection ID
  * @param {string} source - The source of the vector
  * @param {Object} sourceSettings - Settings for the source, if it needs any

 /**
  * Gets the hashes of the items in the vector collection
  * @param {import('../users.js').UserDirectoryList} directories - User directories
  * @param {string} collectionId - The collection ID
  * @param {string} source - The source of the vector
  * @param {Object} sourceSettings - Settings for the source, if it needs any

 /**
  * Deletes items from the vector collection by hash
  * @param {import('../users.js').UserDirectoryList} directories - User directories
  * @param {string} collectionId - The collection ID
  * @param {string} source - The source of the vector
  * @param {Object} sourceSettings - Settings for the source, if it needs any

 /**
  * Gets the hashes of the items in the vector collection that match the search text
  * @param {import('../users.js').UserDirectoryList} directories - User directories
  * @param {string} collectionId - The collection ID
  * @param {string} source - The source of the vector
  * @param {Object} sourceSettings - Settings for the source, if it needs any

 /**
  * Queries multiple collections for the given search queries. Returns the overall top K results.
  * @param {import('../users.js').UserDirectoryList} directories - User directories
  * @param {string[]} collectionIds - The collection IDs to query
  * @param {string} source - The source of the vector
  * @param {Object} sourceSettings - Settings for the source, if it needs any

src/endpoints/worldinfo.js+1 -1 Viewed

 /**
  * Reads a World Info file and returns its contents
  * @param {import('../users.js').UserDirectoryList} directories User directories
  * @param {string} worldInfoName Name of the World Info file
  * @param {boolean} allowDummy If true, returns an empty object if the file doesn't exist
  * @returns {object} World Info file contents

src/middleware/basicAuth.js+1 -0 Viewed

  * When applied, this middleware will ensure the request contains the required header for basic authentication and only
  * allow access to the endpoint after successful authentication.
  */
 +import { Buffer } from 'node:buffer';
 import storage from 'node-persist';
 import { getAllUserHandles, toKey, getPasswordHash } from '../users.js';
 import { getConfig, getConfigValue } from '../util.js';

src/middleware/multerMonkeyPatch.js+2 -0 Viewed

 +import { Buffer } from 'node:buffer';
++
 /**
  * Decodes a file name from Latin1 to UTF-8.
  * @param {string} str Input string

src/transformers.mjs+1 -0 Viewed

 import path from 'node:path';
 import fs from 'node:fs';
 +import { Buffer } from 'node:buffer';
 import { pipeline, env, RawImage, Pipeline } from 'sillytavern-transformers';
 import { getConfigValue } from './util.js';

src/users.js+3 -2 Viewed

 import * as fs from 'node:fs';
 import * as crypto from 'node:crypto';
 import * as os from 'node:os';
 +import { Buffer } from 'node:buffer';
 // Express and other dependencies
 import storage from 'node-persist';

 /**
  * Ensures that the content directories exist.
  * @returns {Promise<import('./users.js').UserDirectoryList[]>} - The list of user directories
  */
 export async function ensurePublicDirectoriesExist() {
     for (const dir of Object.values(PUBLIC_DIRECTORIES)) {

 /**
  * Gets a list of all user directories.
  * @returns {Promise<import('./users.js').UserDirectoryList[]>} - The list of user directories
  */
 export async function getUserDirectoriesList() {
     const userHandles = await getAllUserHandles();

src/util.js+1 -0 Viewed

 import * as http2 from 'node:http2';
 import { Readable } from 'node:stream';
 import { createRequire } from 'node:module';
 +import { Buffer } from 'node:buffer';
 import yaml from 'yaml';
 import { sync as commandExistsSync } from 'command-exists';

src/vectors/cohere-vectors.js+2 -2 Viewed

  * Gets the vector for the given text batch from an OpenAI compatible endpoint.
  * @param {string[]} texts - The array of texts to get the vector for
  * @param {boolean} isQuery - If the text is a query for embedding search
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @param {string} model - The model to use for the embedding
  * @returns {Promise<number[][]>} - The array of vectors for the texts
  */

  * Gets the vector for the given text from an OpenAI compatible endpoint.
  * @param {string} text - The text to get the vector for
  * @param {boolean} isQuery - If the text is a query for embedding search
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @param {string} model - The model to use for the embedding
  * @returns {Promise<number[]>} - The vector for the text
  */

src/vectors/llamacpp-vectors.js+2 -2 Viewed

  * Gets the vector for the given text from LlamaCpp
  * @param {string[]} texts - The array of texts to get the vectors for
  * @param {string} apiUrl - The API URL
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[][]>} - The array of vectors for the texts
  */
 export async function getLlamaCppBatchVector(texts, apiUrl, directories) {

  * Gets the vector for the given text from LlamaCpp
  * @param {string} text - The text to get the vector for
  * @param {string} apiUrl - The API URL
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[]>} - The vector for the text
  */
 export async function getLlamaCppVector(text, apiUrl, directories) {

src/vectors/makersuite-vectors.js+2 -2 Viewed

 /**
  * Gets the vector for the given text from gecko model
  * @param {string[]} texts - The array of texts to get the vector for
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[][]>} - The array of vectors for the texts
  */
 export async function getMakerSuiteBatchVector(texts, directories) {

 /**
  * Gets the vector for the given text from Gemini API text-embedding-004 model
  * @param {string} text - The text to get the vector for
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[]>} - The vector for the text
  */
 export async function getMakerSuiteVector(text, directories) {

src/vectors/nomicai-vectors.js+2 -2 Viewed

  * Gets the vector for the given text batch from an OpenAI compatible endpoint.
  * @param {string[]} texts - The array of texts to get the vector for
  * @param {string} source - The source of the vector
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[][]>} - The array of vectors for the texts
  */
 export async function getNomicAIBatchVector(texts, source, directories) {

  * Gets the vector for the given text from an OpenAI compatible endpoint.
  * @param {string} text - The text to get the vector for
  * @param {string} source - The source of the vector
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[]>} - The vector for the text
  */
 export async function getNomicAIVector(text, source, directories) {

src/vectors/ollama-vectors.js+2 -2 Viewed

  * @param {string} apiUrl - The API URL
  * @param {string} model - The model to use
  * @param {boolean} keep - Keep the model loaded in memory
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[][]>} - The array of vectors for the texts
  */
 export async function getOllamaBatchVector(texts, apiUrl, model, keep, directories) {

  * @param {string} apiUrl - The API URL
  * @param {string} model - The model to use
  * @param {boolean} keep - Keep the model loaded in memory
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[]>} - The vector for the text
  */
 export async function getOllamaVector(text, apiUrl, model, keep, directories) {

src/vectors/openai-vectors.js+2 -2 Viewed

  * Gets the vector for the given text batch from an OpenAI compatible endpoint.
  * @param {string[]} texts - The array of texts to get the vector for
  * @param {string} source - The source of the vector
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @param {string} model - The model to use for the embedding
  * @returns {Promise<number[][]>} - The array of vectors for the texts
  */

  * Gets the vector for the given text from an OpenAI compatible endpoint.
  * @param {string} text - The text to get the vector for
  * @param {string} source - The source of the vector
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @param {string} model - The model to use for the embedding
  * @returns {Promise<number[]>} - The vector for the text
  */

src/vectors/vllm-vectors.js+2 -2 Viewed

  * @param {string[]} texts - The array of texts to get the vectors for
  * @param {string} apiUrl - The API URL
  * @param {string} model - The model to use
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[][]>} - The array of vectors for the texts
  */
 export async function getVllmBatchVector(texts, apiUrl, model, directories) {

  * @param {string} text - The text to get the vector for
  * @param {string} apiUrl - The API URL
  * @param {string} model - The model to use
  * @param {import('../users.js').UserDirectoryList} directories - The directories object for the user
  * @returns {Promise<number[]>} - The vector for the text
  */
 export async function getVllmVector(text, apiUrl, model, directories) {

Explicitly import Buffer. Specify jsdoc local extensions