Skip to content

Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active

📦 refactor: Consolidate DB models, encapsulating Mongoose usage in `data-schemas` (#11830)

Danny Avila8ba2bde5c15c
diff --git a/api/app/clients/BaseClient.js b/api/app/clients/BaseClient.js
index 8f931f8a5e..a7ad089d20 100644
--- a/api/app/clients/BaseClient.js
+++ b/api/app/clients/BaseClient.js
@@ -3,6 +3,7 @@ const fetch = require('node-fetch');
const { logger } = require('@librechat/data-schemas');
const {
countTokens,
+ checkBalance,
getBalanceConfig,
buildMessageFiles,
extractFileContext,
@@ -23,18 +24,11 @@ const {
supportsBalanceCheck,
isBedrockDocumentType,
} = require('librechat-data-provider');
-const {
- updateMessage,
- getMessages,
- saveMessage,
- saveConvo,
- getConvo,
- getFiles,
-} = require('~/models');
const { getStrategyFunctions } = require('~/server/services/Files/strategies');
-const { checkBalance } = require('~/models/balanceMethods');
const { truncateToolCallOutputs } = require('./prompts');
+const { logViolation } = require('~/cache');
const TextStream = require('./TextStream');
+const db = require('~/models');
class BaseClient {
constructor(apiKey, options = {}) {
@@ -700,18 +694,26 @@ class BaseClient {
balanceConfig?.enabled &&
supportsBalanceCheck[this.options.endpointType ?? this.options.endpoint]
) {
- await checkBalance({
- req: this.options.req,
- res: this.options.res,
- txData: {
- user: this.user,
- tokenType: 'prompt',
- amount: promptTokens,
- endpoint: this.options.endpoint,
- model: this.modelOptions?.model ?? this.model,
- endpointTokenConfig: this.options.endpointTokenConfig,
+ await checkBalance(
+ {
+ req: this.options.req,
+ res: this.options.res,
+ txData: {
+ user: this.user,
+ tokenType: 'prompt',
+ amount: promptTokens,
+ endpoint: this.options.endpoint,
+ model: this.modelOptions?.model ?? this.model,
+ endpointTokenConfig: this.options.endpointTokenConfig,
+ },
},
- });
+ {
+ logViolation,
+ getMultiplier: db.getMultiplier,
+ findBalanceByUser: db.findBalanceByUser,
+ createAutoRefillTransaction: db.createAutoRefillTransaction,
+ },
+ );
}
const { completion, metadata } = await this.sendCompletion(payload, opts);
@@ -909,7 +911,7 @@ class BaseClient {
async loadHistory(conversationId, parentMessageId = null) {
logger.debug('[BaseClient] Loading history:', { conversationId, parentMessageId });
- const messages = (await getMessages({ conversationId })) ?? [];
+ const messages = (await db.getMessages({ conversationId })) ?? [];
if (messages.length === 0) {
return [];
@@ -965,8 +967,13 @@ class BaseClient {
}
const hasAddedConvo = this.options?.req?.body?.addedConvo != null;
- const savedMessage = await saveMessage(
- this.options?.req,
+ const reqCtx = {
+ userId: this.options?.req?.user?.id,
+ isTemporary: this.options?.req?.body?.isTemporary,
+ interfaceConfig: this.options?.req?.config?.interfaceConfig,
+ };
+ const savedMessage = await db.saveMessage(
+ reqCtx,
{
...message,
endpoint: this.options.endpoint,
@@ -991,7 +998,7 @@ class BaseClient {
const existingConvo =
this.fetchedConvo === true
? null
- : await getConvo(this.options?.req?.user?.id, message.conversationId);
+ : await db.getConvo(this.options?.req?.user?.id, message.conversationId);
const unsetFields = {};
const exceptions = new Set(['spec', 'iconURL']);
@@ -1018,7 +1025,7 @@ class BaseClient {
}
}
- const conversation = await saveConvo(this.options?.req, fieldsToKeep, {
+ const conversation = await db.saveConvo(reqCtx, fieldsToKeep, {
context: 'api/app/clients/BaseClient.js - saveMessageToDatabase #saveConvo',
unsetFields,
});
@@ -1031,7 +1038,7 @@ class BaseClient {
* @param {Partial<TMessage>} message
*/
async updateMessageInDatabase(message) {
- await updateMessage(this.options.req, message);
+ await db.updateMessage(this.options?.req?.user?.id, message);
}
/**
@@ -1431,7 +1438,7 @@ class BaseClient {
return message;
}
- const files = await getFiles(
+ const files = await db.getFiles(
{
file_id: { $in: fileIds },
},
diff --git a/api/app/clients/tools/structured/GeminiImageGen.js b/api/app/clients/tools/structured/GeminiImageGen.js
index 0bd1e302ed..f197f1d41b 100644
--- a/api/app/clients/tools/structured/GeminiImageGen.js
+++ b/api/app/clients/tools/structured/GeminiImageGen.js
@@ -13,8 +13,7 @@ const {
getTransactionsConfig,
} = require('@librechat/api');
const { getStrategyFunctions } = require('~/server/services/Files/strategies');
-const { spendTokens } = require('~/models/spendTokens');
-const { getFiles } = require('~/models/File');
+const { spendTokens, getFiles } = require('~/models');
/**
* Configure proxy support for Google APIs
diff --git a/api/app/clients/tools/util/handleTools.js b/api/app/clients/tools/util/handleTools.js
index d82a0d6930..4b86101425 100644
--- a/api/app/clients/tools/util/handleTools.js
+++ b/api/app/clients/tools/util/handleTools.js
@@ -45,7 +45,7 @@ const { getUserPluginAuthValue } = require('~/server/services/PluginService');
const { createMCPTool, createMCPTools } = require('~/server/services/MCP');
const { loadAuthValues } = require('~/server/services/Tools/credentials');
const { getMCPServerTools } = require('~/server/services/Config');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
/**
* Validates the availability and authentication of tools for a user based on environment variables or user-specific plugin authentication values.
diff --git a/api/models/Action.js b/api/models/Action.js
deleted file mode 100644
index f14c415d5b..0000000000
--- a/api/models/Action.js
+++ /dev/null
@@ -1,73 +0,0 @@
-const { Action } = require('~/db/models');
-
-/**
- * Update an action with new data without overwriting existing properties,
- * or create a new action if it doesn't exist.
- *
- * @param {{ action_id: string, agent_id?: string, assistant_id?: string, user?: string }} searchParams
- * @param {Object} updateData - An object containing the properties to update.
- * @returns {Promise<Action>} The updated or newly created action document as a plain object.
- */
-const updateAction = async (searchParams, updateData) => {
- const options = { new: true, upsert: true };
- return await Action.findOneAndUpdate(searchParams, updateData, options).lean();
-};
-
-/**
- * Retrieves all actions that match the given search parameters.
- *
- * @param {Object} searchParams - The search parameters to find matching actions.
- * @param {boolean} includeSensitive - Flag to include sensitive data in the metadata.
- * @returns {Promise<Array<Action>>} A promise that resolves to an array of action documents as plain objects.
- */
-const getActions = async (searchParams, includeSensitive = false) => {
- const actions = await Action.find(searchParams).lean();
-
- if (!includeSensitive) {
- for (let i = 0; i < actions.length; i++) {
- const metadata = actions[i].metadata;
- if (!metadata) {
- continue;
- }
-
- const sensitiveFields = ['api_key', 'oauth_client_id', 'oauth_client_secret'];
- for (let field of sensitiveFields) {
- if (metadata[field]) {
- delete metadata[field];
- }
- }
- }
- }
-
- return actions;
-};
-
-/**
- * Deletes an action by params.
- *
- * @param {{ action_id: string, agent_id?: string, assistant_id?: string, user?: string }} searchParams
- * @returns {Promise<Action|null>} The deleted action document as a plain object, or null if no match.
- */
-const deleteAction = async (searchParams) => {
- return await Action.findOneAndDelete(searchParams).lean();
-};
-
-/**
- * Deletes actions by params.
- *
- * @param {Object} searchParams - The search parameters to find the actions to delete.
- * @param {string} searchParams.action_id - The ID of the action(s) to delete.
- * @param {string} searchParams.user - The user ID of the action's author.
- * @returns {Promise<Number>} A promise that resolves to the number of deleted action documents.
- */
-const deleteActions = async (searchParams) => {
- const result = await Action.deleteMany(searchParams);
- return result.deletedCount;
-};
-
-module.exports = {
- getActions,
- updateAction,
- deleteAction,
- deleteActions,
-};
diff --git a/api/models/Agent.js b/api/models/Agent.js
deleted file mode 100644
index 1ddc535e7b..0000000000
--- a/api/models/Agent.js
+++ /dev/null
@@ -1,890 +0,0 @@
-const mongoose = require('mongoose');
-const crypto = require('node:crypto');
-const { logger } = require('@librechat/data-schemas');
-const { getCustomEndpointConfig } = require('@librechat/api');
-const {
- Tools,
- ResourceType,
- actionDelimiter,
- isAgentsEndpoint,
- isEphemeralAgentId,
- encodeEphemeralAgentId,
-} = require('librechat-data-provider');
-const { mcp_all, mcp_delimiter } = require('librechat-data-provider').Constants;
-const {
- getSoleOwnedResourceIds,
- removeAllPermissions,
-} = require('~/server/services/PermissionService');
-const { getMCPServerTools } = require('~/server/services/Config');
-const { Agent, AclEntry, User } = require('~/db/models');
-const { getActions } = require('./Action');
-
-/**
- * Extracts unique MCP server names from tools array
- * Tools format: "toolName_mcp_serverName" or "sys__server__sys_mcp_serverName"
- * @param {string[]} tools - Array of tool identifiers
- * @returns {string[]} Array of unique MCP server names
- */
-const extractMCPServerNames = (tools) => {
- if (!tools || !Array.isArray(tools)) {
- return [];
- }
- const serverNames = new Set();
- for (const tool of tools) {
- if (!tool || !tool.includes(mcp_delimiter)) {
- continue;
- }
- const parts = tool.split(mcp_delimiter);
- if (parts.length >= 2) {
- serverNames.add(parts[parts.length - 1]);
- }
- }
- return Array.from(serverNames);
-};
-
-/**
- * Create an agent with the provided data.
- * @param {Object} agentData - The agent data to create.
- * @returns {Promise<Agent>} The created agent document as a plain object.
- * @throws {Error} If the agent creation fails.
- */
-const createAgent = async (agentData) => {
- const { author: _author, ...versionData } = agentData;
- const timestamp = new Date();
- const initialAgentData = {
- ...agentData,
- versions: [
- {
- ...versionData,
- createdAt: timestamp,
- updatedAt: timestamp,
- },
- ],
- category: agentData.category || 'general',
- mcpServerNames: extractMCPServerNames(agentData.tools),
- };
-
- return (await Agent.create(initialAgentData)).toObject();
-};
-
-/**
- * Get an agent document based on the provided ID.
- *
- * @param {Object} searchParameter - The search parameters to find the agent to update.
- * @param {string} searchParameter.id - The ID of the agent to update.
- * @param {string} searchParameter.author - The user ID of the agent's author.
- * @returns {Promise<Agent|null>} The agent document as a plain object, or null if not found.
- */
-const getAgent = async (searchParameter) => await Agent.findOne(searchParameter).lean();
-
-/**
- * Get multiple agent documents based on the provided search parameters.
- *
- * @param {Object} searchParameter - The search parameters to find agents.
- * @returns {Promise<Agent[]>} Array of agent documents as plain objects.
- */
-const getAgents = async (searchParameter) => await Agent.find(searchParameter).lean();
-
-/**
- * Load an agent based on the provided ID
- *
- * @param {Object} params
- * @param {ServerRequest} params.req
- * @param {string} params.spec
- * @param {string} params.agent_id
- * @param {string} params.endpoint
- * @param {import('@librechat/agents').ClientOptions} [params.model_parameters]
- * @returns {Promise<Agent|null>} The agent document as a plain object, or null if not found.
- */
-const loadEphemeralAgent = async ({ req, spec, endpoint, model_parameters: _m }) => {
- const { model, ...model_parameters } = _m;
- const modelSpecs = req.config?.modelSpecs?.list;
- /** @type {TModelSpec | null} */
- let modelSpec = null;
- if (spec != null && spec !== '') {
- modelSpec = modelSpecs?.find((s) => s.name === spec) || null;
- }
- /** @type {TEphemeralAgent | null} */
- const ephemeralAgent = req.body.ephemeralAgent;
- const mcpServers = new Set(ephemeralAgent?.mcp);
- const userId = req.user?.id; // note: userId cannot be undefined at runtime
- if (modelSpec?.mcpServers) {
- for (const mcpServer of modelSpec.mcpServers) {
- mcpServers.add(mcpServer);
- }
- }
- /** @type {string[]} */
- const tools = [];
- if (ephemeralAgent?.execute_code === true || modelSpec?.executeCode === true) {
- tools.push(Tools.execute_code);
- }
- if (ephemeralAgent?.file_search === true || modelSpec?.fileSearch === true) {
- tools.push(Tools.file_search);
- }
- if (ephemeralAgent?.web_search === true || modelSpec?.webSearch === true) {
- tools.push(Tools.web_search);
- }
-
- const addedServers = new Set();
- if (mcpServers.size > 0) {
- for (const mcpServer of mcpServers) {
- if (addedServers.has(mcpServer)) {
- continue;
- }
- const serverTools = await getMCPServerTools(userId, mcpServer);
- if (!serverTools) {
- tools.push(`${mcp_all}${mcp_delimiter}${mcpServer}`);
- addedServers.add(mcpServer);
- continue;
- }
- tools.push(...Object.keys(serverTools));
- addedServers.add(mcpServer);
- }
- }
-
- const instructions = req.body.promptPrefix;
-
- // Get endpoint config for modelDisplayLabel fallback
- const appConfig = req.config;
- let endpointConfig = appConfig?.endpoints?.[endpoint];
- if (!isAgentsEndpoint(endpoint) && !endpointConfig) {
- try {
- endpointConfig = getCustomEndpointConfig({ endpoint, appConfig });
- } catch (err) {
- logger.error('[loadEphemeralAgent] Error getting custom endpoint config', err);
- }
- }
-
- // For ephemeral agents, use modelLabel if provided, then model spec's label,
- // then modelDisplayLabel from endpoint config, otherwise empty string to show model name
- const sender =
- model_parameters?.modelLabel ?? modelSpec?.label ?? endpointConfig?.modelDisplayLabel ?? '';
-
- // Encode ephemeral agent ID with endpoint, model, and computed sender for display
- const ephemeralId = encodeEphemeralAgentId({ endpoint, model, sender });
-
- const result = {
- id: ephemeralId,
- instructions,
- provider: endpoint,
- model_parameters,
- model,
- tools,
- };
-
- if (ephemeralAgent?.artifacts != null && ephemeralAgent.artifacts) {
- result.artifacts = ephemeralAgent.artifacts;
- }
- return result;
-};
-
-/**
- * Load an agent based on the provided ID
- *
- * @param {Object} params
- * @param {ServerRequest} params.req
- * @param {string} params.spec
- * @param {string} params.agent_id
- * @param {string} params.endpoint
- * @param {import('@librechat/agents').ClientOptions} [params.model_parameters]
- * @returns {Promise<Agent|null>} The agent document as a plain object, or null if not found.
- */
-const loadAgent = async ({ req, spec, agent_id, endpoint, model_parameters }) => {
- if (!agent_id) {
- return null;
- }
- if (isEphemeralAgentId(agent_id)) {
- return await loadEphemeralAgent({ req, spec, endpoint, model_parameters });
- }
- const agent = await getAgent({
- id: agent_id,
- });
-
- if (!agent) {
- return null;
- }
-
- agent.version = agent.versions ? agent.versions.length : 0;
- return agent;
-};
-
-/**
- * Check if a version already exists in the versions array, excluding timestamp and author fields
- * @param {Object} updateData - The update data to compare
- * @param {Object} currentData - The current agent data
- * @param {Array} versions - The existing versions array
- * @param {string} [actionsHash] - Hash of current action metadata
- * @returns {Object|null} - The matching version if found, null otherwise
- */
-const isDuplicateVersion = (updateData, currentData, versions, actionsHash = null) => {
- if (!versions || versions.length === 0) {
- return null;
- }
-
- const excludeFields = [
- '_id',
- 'id',
- 'createdAt',
- 'updatedAt',
- 'author',
- 'updatedBy',
- 'created_at',
- 'updated_at',
- '__v',
- 'versions',
- 'actionsHash', // Exclude actionsHash from direct comparison
- ];
-
- const { $push: _$push, $pull: _$pull, $addToSet: _$addToSet, ...directUpdates } = updateData;
-
- if (Object.keys(directUpdates).length === 0 && !actionsHash) {
- return null;
- }
-
- const wouldBeVersion = { ...currentData, ...directUpdates };
- const lastVersion = versions[versions.length - 1];
-
- if (actionsHash && lastVersion.actionsHash !== actionsHash) {
- return null;
- }
-
- const allFields = new Set([...Object.keys(wouldBeVersion), ...Object.keys(lastVersion)]);
-
- const importantFields = Array.from(allFields).filter((field) => !excludeFields.includes(field));
-
- let isMatch = true;
- for (const field of importantFields) {
- const wouldBeValue = wouldBeVersion[field];
- const lastVersionValue = lastVersion[field];
-
- // Skip if both are undefined/null
- if (!wouldBeValue && !lastVersionValue) {
- continue;
- }
-
- // Handle arrays
- if (Array.isArray(wouldBeValue) || Array.isArray(lastVersionValue)) {
- // Normalize: treat undefined/null as empty array for comparison
- let wouldBeArr;
- if (Array.isArray(wouldBeValue)) {
- wouldBeArr = wouldBeValue;
- } else if (wouldBeValue == null) {
- wouldBeArr = [];
- } else {
- wouldBeArr = [wouldBeValue];
- }
-
- let lastVersionArr;
- if (Array.isArray(lastVersionValue)) {
- lastVersionArr = lastVersionValue;
- } else if (lastVersionValue == null) {
- lastVersionArr = [];
- } else {
- lastVersionArr = [lastVersionValue];
- }
-
- if (wouldBeArr.length !== lastVersionArr.length) {
- isMatch = false;
- break;
- }
-
- // Handle arrays of objects
- if (wouldBeArr.length > 0 && typeof wouldBeArr[0] === 'object' && wouldBeArr[0] !== null) {
- const sortedWouldBe = [...wouldBeArr].map((item) => JSON.stringify(item)).sort();
- const sortedVersion = [...lastVersionArr].map((item) => JSON.stringify(item)).sort();
-
- if (!sortedWouldBe.every((item, i) => item === sortedVersion[i])) {
- isMatch = false;
- break;
- }
- } else {
- const sortedWouldBe = [...wouldBeArr].sort();
- const sortedVersion = [...lastVersionArr].sort();
-
- if (!sortedWouldBe.every((item, i) => item === sortedVersion[i])) {
- isMatch = false;
- break;
- }
- }
- }
- // Handle objects
- else if (typeof wouldBeValue === 'object' && wouldBeValue !== null) {
- const lastVersionObj =
- typeof lastVersionValue === 'object' && lastVersionValue !== null ? lastVersionValue : {};
-
- // For empty objects, normalize the comparison
- const wouldBeKeys = Object.keys(wouldBeValue);
- const lastVersionKeys = Object.keys(lastVersionObj);
-
- // If both are empty objects, they're equal
- if (wouldBeKeys.length === 0 && lastVersionKeys.length === 0) {
- continue;
- }
-
- // Otherwise do a deep comparison
- if (JSON.stringify(wouldBeValue) !== JSON.stringify(lastVersionObj)) {
- isMatch = false;
- break;
- }
- }
- // Handle primitive values
- else {
- // For primitives, handle the case where one is undefined and the other is a default value
- if (wouldBeValue !== lastVersionValue) {
- // Special handling for boolean false vs undefined
- if (
- typeof wouldBeValue === 'boolean' &&
- wouldBeValue === false &&
- lastVersionValue === undefined
- ) {
- continue;
- }
- // Special handling for empty string vs undefined
- if (
- typeof wouldBeValue === 'string' &&
- wouldBeValue === '' &&
- lastVersionValue === undefined
- ) {
- continue;
- }
- isMatch = false;
- break;
- }
- }
- }
-
- return isMatch ? lastVersion : null;
-};
-
-/**
- * Update an agent with new data without overwriting existing
- * properties, or create a new agent if it doesn't exist.
- * When an agent is updated, a copy of the current state will be saved to the versions array.
- *
- * @param {Object} searchParameter - The search parameters to find the agent to update.
- * @param {string} searchParameter.id - The ID of the agent to update.
- * @param {string} [searchParameter.author] - The user ID of the agent's author.
- * @param {Object} updateData - An object containing the properties to update.
- * @param {Object} [options] - Optional configuration object.
- * @param {string} [options.updatingUserId] - The ID of the user performing the update (used for tracking non-author updates).
- * @param {boolean} [options.forceVersion] - Force creation of a new version even if no fields changed.
- * @param {boolean} [options.skipVersioning] - Skip version creation entirely (useful for isolated operations like sharing).
- * @returns {Promise<Agent>} The updated or newly created agent document as a plain object.
- * @throws {Error} If the update would create a duplicate version
- */
-const updateAgent = async (searchParameter, updateData, options = {}) => {
- const { updatingUserId = null, forceVersion = false, skipVersioning = false } = options;
- const mongoOptions = { new: true, upsert: false };
-
- const currentAgent = await Agent.findOne(searchParameter);
- if (currentAgent) {
- const {
- __v,
- _id,
- id: __id,
- versions,
- author: _author,
- ...versionData
- } = currentAgent.toObject();
- const { $push, $pull, $addToSet, ...directUpdates } = updateData;
-
- // Sync mcpServerNames when tools are updated
- if (directUpdates.tools !== undefined) {
- const mcpServerNames = extractMCPServerNames(directUpdates.tools);
- directUpdates.mcpServerNames = mcpServerNames;
- updateData.mcpServerNames = mcpServerNames; // Also update the original updateData
- }
-
- let actionsHash = null;
-
- // Generate actions hash if agent has actions
- if (currentAgent.actions && currentAgent.actions.length > 0) {
- // Extract action IDs from the format "domain_action_id"
- const actionIds = currentAgent.actions
- .map((action) => {
- const parts = action.split(actionDelimiter);
- return parts[1]; // Get just the action ID part
- })
- .filter(Boolean);
-
- if (actionIds.length > 0) {
- try {
- const actions = await getActions(
- {
- action_id: { $in: actionIds },
- },
- true,
- ); // Include sensitive data for hash
-
- actionsHash = await generateActionMetadataHash(currentAgent.actions, actions);
- } catch (error) {
- logger.error('Error fetching actions for hash generation:', error);
- }
- }
- }
-
- const shouldCreateVersion =
- !skipVersioning &&
- (forceVersion || Object.keys(directUpdates).length > 0 || $push || $pull || $addToSet);
-
- if (shouldCreateVersion) {
- const duplicateVersion = isDuplicateVersion(updateData, versionData, versions, actionsHash);
- if (duplicateVersion && !forceVersion) {
- // No changes detected, return the current agent without creating a new version
- const agentObj = currentAgent.toObject();
- agentObj.version = versions.length;
- return agentObj;
- }
- }
-
- const versionEntry = {
- ...versionData,
- ...directUpdates,
- updatedAt: new Date(),
- };
-
- // Include actions hash in version if available
- if (actionsHash) {
- versionEntry.actionsHash = actionsHash;
- }
-
- // Always store updatedBy field to track who made the change
- if (updatingUserId) {
- versionEntry.updatedBy = new mongoose.Types.ObjectId(updatingUserId);
- }
-
- if (shouldCreateVersion) {
- updateData.$push = {
- ...($push || {}),
- versions: versionEntry,
- };
- }
- }
-
- return Agent.findOneAndUpdate(searchParameter, updateData, mongoOptions).lean();
-};
-
-/**
- * Modifies an agent with the resource file id.
- * @param {object} params
- * @param {ServerRequest} params.req
- * @param {string} params.agent_id
- * @param {string} params.tool_resource
- * @param {string} params.file_id
- * @returns {Promise<Agent>} The updated agent.
- */
-const addAgentResourceFile = async ({ req, agent_id, tool_resource, file_id }) => {
- const searchParameter = { id: agent_id };
- let agent = await getAgent(searchParameter);
- if (!agent) {
- throw new Error('Agent not found for adding resource file');
- }
- const fileIdsPath = `tool_resources.${tool_resource}.file_ids`;
- await Agent.updateOne(
- {
- id: agent_id,
- [`${fileIdsPath}`]: { $exists: false },
- },
- {
- $set: {
- [`${fileIdsPath}`]: [],
- },
- },
- );
-
- const updateData = {
- $addToSet: {
- tools: tool_resource,
- [fileIdsPath]: file_id,
- },
- };
-
- const updatedAgent = await updateAgent(searchParameter, updateData, {
- updatingUserId: req?.user?.id,
- });
- if (updatedAgent) {
- return updatedAgent;
- } else {
- throw new Error('Agent not found for adding resource file');
- }
-};
-
-/**
- * Removes multiple resource files from an agent using atomic operations.
- * @param {object} params
- * @param {string} params.agent_id
- * @param {Array<{tool_resource: string, file_id: string}>} params.files
- * @returns {Promise<Agent>} The updated agent.
- * @throws {Error} If the agent is not found or update fails.
- */
-const removeAgentResourceFiles = async ({ agent_id, files }) => {
- const searchParameter = { id: agent_id };
-
- // Group files to remove by resource
- const filesByResource = files.reduce((acc, { tool_resource, file_id }) => {
- if (!acc[tool_resource]) {
- acc[tool_resource] = [];
- }
- acc[tool_resource].push(file_id);
- return acc;
- }, {});
-
- const pullAllOps = {};
- const resourcesToCheck = new Set();
- for (const [resource, fileIds] of Object.entries(filesByResource)) {
- const fileIdsPath = `tool_resources.${resource}.file_ids`;
- pullAllOps[fileIdsPath] = fileIds;
- resourcesToCheck.add(resource);
- }
-
- const updatePullData = { $pullAll: pullAllOps };
- const agentAfterPull = await Agent.findOneAndUpdate(searchParameter, updatePullData, {
- new: true,
- }).lean();
-
- if (!agentAfterPull) {
- // Agent might have been deleted concurrently, or never existed.
- // Check if it existed before trying to throw.
- const agentExists = await getAgent(searchParameter);
- if (!agentExists) {
- throw new Error('Agent not found for removing resource files');
- }
- // If it existed but findOneAndUpdate returned null, something else went wrong.
- throw new Error('Failed to update agent during file removal (pull step)');
- }
-
- // Return the agent state directly after the $pull operation.
- // Skipping the $unset step for now to simplify and test core $pull atomicity.
- // Empty arrays might remain, but the removal itself should be correct.
- return agentAfterPull;
-};
-
-/**
- * Deletes an agent based on the provided ID.
- *
- * @param {Object} searchParameter - The search parameters to find the agent to delete.
- * @param {string} searchParameter.id - The ID of the agent to delete.
- * @param {string} [searchParameter.author] - The user ID of the agent's author.
- * @returns {Promise<void>} Resolves when the agent has been successfully deleted.
- */
-const deleteAgent = async (searchParameter) => {
- const agent = await Agent.findOneAndDelete(searchParameter);
- if (agent) {
- await Promise.all([
- removeAllPermissions({
- resourceType: ResourceType.AGENT,
- resourceId: agent._id,
- }),
- removeAllPermissions({
- resourceType: ResourceType.REMOTE_AGENT,
- resourceId: agent._id,
- }),
- ]);
- try {
- await Agent.updateMany({ 'edges.to': agent.id }, { $pull: { edges: { to: agent.id } } });
- } catch (error) {
- logger.error('[deleteAgent] Error removing agent from handoff edges', error);
- }
- try {
- await User.updateMany(
- { 'favorites.agentId': agent.id },
- { $pull: { favorites: { agentId: agent.id } } },
- );
- } catch (error) {
- logger.error('[deleteAgent] Error removing agent from user favorites', error);
- }
- }
- return agent;
-};
-
-/**
- * Deletes agents solely owned by the user and cleans up their ACLs/project references.
- * Agents with other owners are left intact; the caller is responsible for
- * removing the user's own ACL principal entries separately.
- *
- * Also handles legacy (pre-ACL) agents that only have the author field set,
- * ensuring they are not orphaned if no permission migration has been run.
- * @param {string} userId - The ID of the user whose agents should be deleted.
- * @returns {Promise<void>}
- */
-const deleteUserAgents = async (userId) => {
- try {
- const userObjectId = new mongoose.Types.ObjectId(userId);
- const soleOwnedObjectIds = await getSoleOwnedResourceIds(userObjectId, [
- ResourceType.AGENT,
- ResourceType.REMOTE_AGENT,
- ]);
-
- const authoredAgents = await Agent.find({ author: userObjectId }).select('id _id').lean();
-
- const migratedEntries =
- authoredAgents.length > 0
- ? await AclEntry.find({
- resourceType: { $in: [ResourceType.AGENT, ResourceType.REMOTE_AGENT] },
- resourceId: { $in: authoredAgents.map((a) => a._id) },
- })
- .select('resourceId')
- .lean()
- : [];
- const migratedIds = new Set(migratedEntries.map((e) => e.resourceId.toString()));
- const legacyAgents = authoredAgents.filter((a) => !migratedIds.has(a._id.toString()));
-
- /** resourceId is the MongoDB _id; agent.id is the string identifier for project/edge queries */
- const soleOwnedAgents =
- soleOwnedObjectIds.length > 0
- ? await Agent.find({ _id: { $in: soleOwnedObjectIds } })
- .select('id _id')
- .lean()
- : [];
-
- const allAgents = [...soleOwnedAgents, ...legacyAgents];
-
- if (allAgents.length === 0) {
- return;
- }
-
- const agentIds = allAgents.map((agent) => agent.id);
- const agentObjectIds = allAgents.map((agent) => agent._id);
-
- await AclEntry.deleteMany({
- resourceType: { $in: [ResourceType.AGENT, ResourceType.REMOTE_AGENT] },
- resourceId: { $in: agentObjectIds },
- });
-
- try {
- await Agent.updateMany(
- { 'edges.to': { $in: agentIds } },
- { $pull: { edges: { to: { $in: agentIds } } } },
- );
- } catch (error) {
- logger.error('[deleteUserAgents] Error removing agents from handoff edges', error);
- }
-
- try {
- await User.updateMany(
- { 'favorites.agentId': { $in: agentIds } },
- { $pull: { favorites: { agentId: { $in: agentIds } } } },
- );
- } catch (error) {
- logger.error('[deleteUserAgents] Error removing agents from user favorites', error);
- }
-
- await Agent.deleteMany({ _id: { $in: agentObjectIds } });
- } catch (error) {
- logger.error('[deleteUserAgents] General error:', error);
- }
-};
-
-/**
- * Get agents by accessible IDs with optional cursor-based pagination.
- * @param {Object} params - The parameters for getting accessible agents.
- * @param {Array} [params.accessibleIds] - Array of agent ObjectIds the user has ACL access to.
- * @param {Object} [params.otherParams] - Additional query parameters (including author filter).
- * @param {number} [params.limit] - Number of agents to return (max 100). If not provided, returns all agents.
- * @param {string} [params.after] - Cursor for pagination - get agents after this cursor. // base64 encoded JSON string with updatedAt and _id.
- * @returns {Promise<Object>} A promise that resolves to an object containing the agents data and pagination info.
- */
-const getListAgentsByAccess = async ({
- accessibleIds = [],
- otherParams = {},
- limit = null,
- after = null,
-}) => {
- const isPaginated = limit !== null && limit !== undefined;
- const normalizedLimit = isPaginated ? Math.min(Math.max(1, parseInt(limit) || 20), 100) : null;
-
- // Build base query combining ACL accessible agents with other filters
- const baseQuery = { ...otherParams, _id: { $in: accessibleIds } };
-
- // Add cursor condition
- if (after) {
- try {
- const cursor = JSON.parse(Buffer.from(after, 'base64').toString('utf8'));
- const { updatedAt, _id } = cursor;
-
- const cursorCondition = {
- $or: [
- { updatedAt: { $lt: new Date(updatedAt) } },
- { updatedAt: new Date(updatedAt), _id: { $gt: new mongoose.Types.ObjectId(_id) } },
- ],
- };
-
- // Merge cursor condition with base query
- if (Object.keys(baseQuery).length > 0) {
- baseQuery.$and = [{ ...baseQuery }, cursorCondition];
- // Remove the original conditions from baseQuery to avoid duplication
- Object.keys(baseQuery).forEach((key) => {
- if (key !== '$and') delete baseQuery[key];
- });
- } else {
- Object.assign(baseQuery, cursorCondition);
- }
- } catch (error) {
- logger.warn('Invalid cursor:', error.message);
- }
- }
-
- let query = Agent.find(baseQuery, {
- id: 1,
- _id: 1,
- name: 1,
- avatar: 1,
- author: 1,
- description: 1,
- updatedAt: 1,
- category: 1,
- support_contact: 1,
- is_promoted: 1,
- }).sort({ updatedAt: -1, _id: 1 });
-
- // Only apply limit if pagination is requested
- if (isPaginated) {
- query = query.limit(normalizedLimit + 1);
- }
-
- const agents = await query.lean();
-
- const hasMore = isPaginated ? agents.length > normalizedLimit : false;
- const data = (isPaginated ? agents.slice(0, normalizedLimit) : agents).map((agent) => {
- if (agent.author) {
- agent.author = agent.author.toString();
- }
- return agent;
- });
-
- // Generate next cursor only if paginated
- let nextCursor = null;
- if (isPaginated && hasMore && data.length > 0) {
- const lastAgent = agents[normalizedLimit - 1];
- nextCursor = Buffer.from(
- JSON.stringify({
- updatedAt: lastAgent.updatedAt.toISOString(),
- _id: lastAgent._id.toString(),
- }),
- ).toString('base64');
- }
-
- return {
- object: 'list',
- data,
- first_id: data.length > 0 ? data[0].id : null,
- last_id: data.length > 0 ? data[data.length - 1].id : null,
- has_more: hasMore,
- after: nextCursor,
- };
-};
-
-/**
- * Reverts an agent to a specific version in its version history.
- * @param {Object} searchParameter - The search parameters to find the agent to revert.
- * @param {string} searchParameter.id - The ID of the agent to revert.
- * @param {string} [searchParameter.author] - The user ID of the agent's author.
- * @param {number} versionIndex - The index of the version to revert to in the versions array.
- * @returns {Promise<MongoAgent>} The updated agent document after reverting.
- * @throws {Error} If the agent is not found or the specified version does not exist.
- */
-const revertAgentVersion = async (searchParameter, versionIndex) => {
- const agent = await Agent.findOne(searchParameter);
- if (!agent) {
- throw new Error('Agent not found');
- }
-
- if (!agent.versions || !agent.versions[versionIndex]) {
- throw new Error(`Version ${versionIndex} not found`);
- }
-
- const revertToVersion = agent.versions[versionIndex];
-
- const updateData = {
- ...revertToVersion,
- };
-
- delete updateData._id;
- delete updateData.id;
- delete updateData.versions;
- delete updateData.author;
- delete updateData.updatedBy;
-
- return Agent.findOneAndUpdate(searchParameter, updateData, { new: true }).lean();
-};
-
-/**
- * Generates a hash of action metadata for version comparison
- * @param {string[]} actionIds - Array of action IDs in format "domain_action_id"
- * @param {Action[]} actions - Array of action documents
- * @returns {Promise<string>} - SHA256 hash of the action metadata
- */
-const generateActionMetadataHash = async (actionIds, actions) => {
- if (!actionIds || actionIds.length === 0) {
- return '';
- }
-
- // Create a map of action_id to metadata for quick lookup
- const actionMap = new Map();
- actions.forEach((action) => {
- actionMap.set(action.action_id, action.metadata);
- });
-
- // Sort action IDs for consistent hashing
- const sortedActionIds = [...actionIds].sort();
-
- // Build a deterministic string representation of all action metadata
- const metadataString = sortedActionIds
- .map((actionFullId) => {
- // Extract just the action_id part (after the delimiter)
- const parts = actionFullId.split(actionDelimiter);
- const actionId = parts[1];
-
- const metadata = actionMap.get(actionId);
- if (!metadata) {
- return `${actionId}:null`;
- }
-
- // Sort metadata keys for deterministic output
- const sortedKeys = Object.keys(metadata).sort();
- const metadataStr = sortedKeys
- .map((key) => `${key}:${JSON.stringify(metadata[key])}`)
- .join(',');
- return `${actionId}:{${metadataStr}}`;
- })
- .join(';');
-
- // Use Web Crypto API to generate hash
- const encoder = new TextEncoder();
- const data = encoder.encode(metadataString);
- const hashBuffer = await crypto.webcrypto.subtle.digest('SHA-256', data);
- const hashArray = Array.from(new Uint8Array(hashBuffer));
- const hashHex = hashArray.map((b) => b.toString(16).padStart(2, '0')).join('');
-
- return hashHex;
-};
-/**
- * Counts the number of promoted agents.
- * @returns {Promise<number>} - The count of promoted agents
- */
-const countPromotedAgents = async () => {
- const count = await Agent.countDocuments({ is_promoted: true });
- return count;
-};
-
-/**
- * Load a default agent based on the endpoint
- * @param {string} endpoint
- * @returns {Agent | null}
- */
-
-module.exports = {
- getAgent,
- getAgents,
- loadAgent,
- createAgent,
- updateAgent,
- deleteAgent,
- deleteUserAgents,
- revertAgentVersion,
- countPromotedAgents,
- addAgentResourceFile,
- getListAgentsByAccess,
- removeAgentResourceFiles,
- generateActionMetadataHash,
-};
diff --git a/api/models/Assistant.js b/api/models/Assistant.js
deleted file mode 100644
index be94d35d7d..0000000000
--- a/api/models/Assistant.js
+++ /dev/null
@@ -1,62 +0,0 @@
-const { Assistant } = require('~/db/models');
-
-/**
- * Update an assistant with new data without overwriting existing properties,
- * or create a new assistant if it doesn't exist.
- *
- * @param {Object} searchParams - The search parameters to find the assistant to update.
- * @param {string} searchParams.assistant_id - The ID of the assistant to update.
- * @param {string} searchParams.user - The user ID of the assistant's author.
- * @param {Object} updateData - An object containing the properties to update.
- * @returns {Promise<AssistantDocument>} The updated or newly created assistant document as a plain object.
- */
-const updateAssistantDoc = async (searchParams, updateData) => {
- const options = { new: true, upsert: true };
- return await Assistant.findOneAndUpdate(searchParams, updateData, options).lean();
-};
-
-/**
- * Retrieves an assistant document based on the provided ID.
- *
- * @param {Object} searchParams - The search parameters to find the assistant to update.
- * @param {string} searchParams.assistant_id - The ID of the assistant to update.
- * @param {string} searchParams.user - The user ID of the assistant's author.
- * @returns {Promise<AssistantDocument|null>} The assistant document as a plain object, or null if not found.
- */
-const getAssistant = async (searchParams) => await Assistant.findOne(searchParams).lean();
-
-/**
- * Retrieves all assistants that match the given search parameters.
- *
- * @param {Object} searchParams - The search parameters to find matching assistants.
- * @param {Object} [select] - Optional. Specifies which document fields to include or exclude.
- * @returns {Promise<Array<AssistantDocument>>} A promise that resolves to an array of assistant documents as plain objects.
- */
-const getAssistants = async (searchParams, select = null) => {
- let query = Assistant.find(searchParams);
-
- if (select) {
- query = query.select(select);
- }
-
- return await query.lean();
-};
-
-/**
- * Deletes an assistant based on the provided ID.
- *
- * @param {Object} searchParams - The search parameters to find the assistant to delete.
- * @param {string} searchParams.assistant_id - The ID of the assistant to delete.
- * @param {string} searchParams.user - The user ID of the assistant's author.
- * @returns {Promise<void>} Resolves when the assistant has been successfully deleted.
- */
-const deleteAssistant = async (searchParams) => {
- return await Assistant.findOneAndDelete(searchParams);
-};
-
-module.exports = {
- updateAssistantDoc,
- deleteAssistant,
- getAssistants,
- getAssistant,
-};
diff --git a/api/models/Banner.js b/api/models/Banner.js
deleted file mode 100644
index 42ad1599ed..0000000000
--- a/api/models/Banner.js
+++ /dev/null
@@ -1,28 +0,0 @@
-const { logger } = require('@librechat/data-schemas');
-const { Banner } = require('~/db/models');
-
-/**
- * Retrieves the current active banner.
- * @returns {Promise<Object|null>} The active banner object or null if no active banner is found.
- */
-const getBanner = async (user) => {
- try {
- const now = new Date();
- const banner = await Banner.findOne({
- displayFrom: { $lte: now },
- $or: [{ displayTo: { $gte: now } }, { displayTo: null }],
- type: 'banner',
- }).lean();
-
- if (!banner || banner.isPublic || user) {
- return banner;
- }
-
- return null;
- } catch (error) {
- logger.error('[getBanners] Error getting banners', error);
- throw new Error('Error getting banners');
- }
-};
-
-module.exports = { getBanner };
diff --git a/api/models/Categories.js b/api/models/Categories.js
deleted file mode 100644
index 34bd2d8ed2..0000000000
--- a/api/models/Categories.js
+++ /dev/null
@@ -1,57 +0,0 @@
-const { logger } = require('@librechat/data-schemas');
-
-const options = [
- {
- label: 'com_ui_idea',
- value: 'idea',
- },
- {
- label: 'com_ui_travel',
- value: 'travel',
- },
- {
- label: 'com_ui_teach_or_explain',
- value: 'teach_or_explain',
- },
- {
- label: 'com_ui_write',
- value: 'write',
- },
- {
- label: 'com_ui_shop',
- value: 'shop',
- },
- {
- label: 'com_ui_code',
- value: 'code',
- },
- {
- label: 'com_ui_misc',
- value: 'misc',
- },
- {
- label: 'com_ui_roleplay',
- value: 'roleplay',
- },
- {
- label: 'com_ui_finance',
- value: 'finance',
- },
-];
-
-module.exports = {
- /**
- * Retrieves the categories asynchronously.
- * @returns {Promise<TGetCategoriesResponse>} An array of category objects.
- * @throws {Error} If there is an error retrieving the categories.
- */
- getCategories: async () => {
- try {
- // const categories = await Categories.find();
- return options;
- } catch (error) {
- logger.error('Error getting categories', error);
- return [];
- }
- },
-};
diff --git a/api/models/Conversation.js b/api/models/Conversation.js
deleted file mode 100644
index 121eaa9696..0000000000
--- a/api/models/Conversation.js
+++ /dev/null
@@ -1,373 +0,0 @@
-const { logger } = require('@librechat/data-schemas');
-const { createTempChatExpirationDate } = require('@librechat/api');
-const { getMessages, deleteMessages } = require('./Message');
-const { Conversation } = require('~/db/models');
-
-/**
- * Searches for a conversation by conversationId and returns a lean document with only conversationId and user.
- * @param {string} conversationId - The conversation's ID.
- * @returns {Promise<{conversationId: string, user: string} | null>} The conversation object with selected fields or null if not found.
- */
-const searchConversation = async (conversationId) => {
- try {
- return await Conversation.findOne({ conversationId }, 'conversationId user').lean();
- } catch (error) {
- logger.error('[searchConversation] Error searching conversation', error);
- throw new Error('Error searching conversation');
- }
-};
-
-/**
- * Retrieves a single conversation for a given user and conversation ID.
- * @param {string} user - The user's ID.
- * @param {string} conversationId - The conversation's ID.
- * @returns {Promise<TConversation>} The conversation object.
- */
-const getConvo = async (user, conversationId) => {
- try {
- return await Conversation.findOne({ user, conversationId }).lean();
- } catch (error) {
- logger.error('[getConvo] Error getting single conversation', error);
- throw new Error('Error getting single conversation');
- }
-};
-
-const deleteNullOrEmptyConversations = async () => {
- try {
- const filter = {
- $or: [
- { conversationId: null },
- { conversationId: '' },
- { conversationId: { $exists: false } },
- ],
- };
-
- const result = await Conversation.deleteMany(filter);
-
- // Delete associated messages
- const messageDeleteResult = await deleteMessages(filter);
-
- logger.info(
- `[deleteNullOrEmptyConversations] Deleted ${result.deletedCount} conversations and ${messageDeleteResult.deletedCount} messages`,
- );
-
- return {
- conversations: result,
- messages: messageDeleteResult,
- };
- } catch (error) {
- logger.error('[deleteNullOrEmptyConversations] Error deleting conversations', error);
- throw new Error('Error deleting conversations with null or empty conversationId');
- }
-};
-
-/**
- * Searches for a conversation by conversationId and returns associated file ids.
- * @param {string} conversationId - The conversation's ID.
- * @returns {Promise<string[] | null>}
- */
-const getConvoFiles = async (conversationId) => {
- try {
- return (await Conversation.findOne({ conversationId }, 'files').lean())?.files ?? [];
- } catch (error) {
- logger.error('[getConvoFiles] Error getting conversation files', error);
- throw new Error('Error getting conversation files');
- }
-};
-
-module.exports = {
- getConvoFiles,
- searchConversation,
- deleteNullOrEmptyConversations,
- /**
- * Saves a conversation to the database.
- * @param {Object} req - The request object.
- * @param {string} conversationId - The conversation's ID.
- * @param {Object} metadata - Additional metadata to log for operation.
- * @returns {Promise<TConversation>} The conversation object.
- */
- saveConvo: async (req, { conversationId, newConversationId, ...convo }, metadata) => {
- try {
- if (metadata?.context) {
- logger.debug(`[saveConvo] ${metadata.context}`);
- }
-
- const messages = await getMessages({ conversationId }, '_id');
- const update = { ...convo, messages, user: req.user.id };
-
- if (newConversationId) {
- update.conversationId = newConversationId;
- }
-
- if (req?.body?.isTemporary) {
- try {
- const appConfig = req.config;
- update.expiredAt = createTempChatExpirationDate(appConfig?.interfaceConfig);
- } catch (err) {
- logger.error('Error creating temporary chat expiration date:', err);
- logger.info(`---\`saveConvo\` context: ${metadata?.context}`);
- update.expiredAt = null;
- }
- } else {
- update.expiredAt = null;
- }
-
- /** @type {{ $set: Partial<TConversation>; $unset?: Record<keyof TConversation, number> }} */
- const updateOperation = { $set: update };
- if (metadata && metadata.unsetFields && Object.keys(metadata.unsetFields).length > 0) {
- updateOperation.$unset = metadata.unsetFields;
- }
-
- /** Note: the resulting Model object is necessary for Meilisearch operations */
- const conversation = await Conversation.findOneAndUpdate(
- { conversationId, user: req.user.id },
- updateOperation,
- {
- new: true,
- upsert: metadata?.noUpsert !== true,
- },
- );
-
- if (!conversation) {
- logger.debug('[saveConvo] Conversation not found, skipping update');
- return null;
- }
-
- return conversation.toObject();
- } catch (error) {
- logger.error('[saveConvo] Error saving conversation', error);
- if (metadata && metadata?.context) {
- logger.info(`[saveConvo] ${metadata.context}`);
- }
- return { message: 'Error saving conversation' };
- }
- },
- bulkSaveConvos: async (conversations) => {
- try {
- const bulkOps = conversations.map((convo) => ({
- updateOne: {
- filter: { conversationId: convo.conversationId, user: convo.user },
- update: convo,
- upsert: true,
- timestamps: false,
- },
- }));
-
- const result = await Conversation.bulkWrite(bulkOps);
- return result;
- } catch (error) {
- logger.error('[bulkSaveConvos] Error saving conversations in bulk', error);
- throw new Error('Failed to save conversations in bulk.');
- }
- },
- getConvosByCursor: async (
- user,
- {
- cursor,
- limit = 25,
- isArchived = false,
- tags,
- search,
- sortBy = 'updatedAt',
- sortDirection = 'desc',
- } = {},
- ) => {
- const filters = [{ user }];
- if (isArchived) {
- filters.push({ isArchived: true });
- } else {
- filters.push({ $or: [{ isArchived: false }, { isArchived: { $exists: false } }] });
- }
-
- if (Array.isArray(tags) && tags.length > 0) {
- filters.push({ tags: { $in: tags } });
- }
-
- filters.push({ $or: [{ expiredAt: null }, { expiredAt: { $exists: false } }] });
-
- if (search) {
- try {
- const meiliResults = await Conversation.meiliSearch(search, { filter: `user = "${user}"` });
- const matchingIds = Array.isArray(meiliResults.hits)
- ? meiliResults.hits.map((result) => result.conversationId)
- : [];
- if (!matchingIds.length) {
- return { conversations: [], nextCursor: null };
- }
- filters.push({ conversationId: { $in: matchingIds } });
- } catch (error) {
- logger.error('[getConvosByCursor] Error during meiliSearch', error);
- throw new Error('Error during meiliSearch');
- }
- }
-
- const validSortFields = ['title', 'createdAt', 'updatedAt'];
- if (!validSortFields.includes(sortBy)) {
- throw new Error(
- `Invalid sortBy field: ${sortBy}. Must be one of ${validSortFields.join(', ')}`,
- );
- }
- const finalSortBy = sortBy;
- const finalSortDirection = sortDirection === 'asc' ? 'asc' : 'desc';
-
- let cursorFilter = null;
- if (cursor) {
- try {
- const decoded = JSON.parse(Buffer.from(cursor, 'base64').toString());
- const { primary, secondary } = decoded;
- const primaryValue = finalSortBy === 'title' ? primary : new Date(primary);
- const secondaryValue = new Date(secondary);
- const op = finalSortDirection === 'asc' ? '$gt' : '$lt';
-
- cursorFilter = {
- $or: [
- { [finalSortBy]: { [op]: primaryValue } },
- {
- [finalSortBy]: primaryValue,
- updatedAt: { [op]: secondaryValue },
- },
- ],
- };
- } catch (_err) {
- logger.warn('[getConvosByCursor] Invalid cursor format, starting from beginning');
- }
- if (cursorFilter) {
- filters.push(cursorFilter);
- }
- }
-
- const query = filters.length === 1 ? filters[0] : { $and: filters };
-
- try {
- const sortOrder = finalSortDirection === 'asc' ? 1 : -1;
- const sortObj = { [finalSortBy]: sortOrder };
-
- if (finalSortBy !== 'updatedAt') {
- sortObj.updatedAt = sortOrder;
- }
-
- const convos = await Conversation.find(query)
- .select(
- 'conversationId endpoint title createdAt updatedAt user model agent_id assistant_id spec iconURL',
- )
- .sort(sortObj)
- .limit(limit + 1)
- .lean();
-
- let nextCursor = null;
- if (convos.length > limit) {
- convos.pop(); // Remove extra item used to detect next page
- // Create cursor from the last RETURNED item (not the popped one)
- const lastReturned = convos[convos.length - 1];
- const primaryValue = lastReturned[finalSortBy];
- const primaryStr = finalSortBy === 'title' ? primaryValue : primaryValue.toISOString();
- const secondaryStr = lastReturned.updatedAt.toISOString();
- const composite = { primary: primaryStr, secondary: secondaryStr };
- nextCursor = Buffer.from(JSON.stringify(composite)).toString('base64');
- }
-
- return { conversations: convos, nextCursor };
- } catch (error) {
- logger.error('[getConvosByCursor] Error getting conversations', error);
- throw new Error('Error getting conversations');
- }
- },
- getConvosQueried: async (user, convoIds, cursor = null, limit = 25) => {
- try {
- if (!convoIds?.length) {
- return { conversations: [], nextCursor: null, convoMap: {} };
- }
-
- const conversationIds = convoIds.map((convo) => convo.conversationId);
-
- const results = await Conversation.find({
- user,
- conversationId: { $in: conversationIds },
- $or: [{ expiredAt: { $exists: false } }, { expiredAt: null }],
- }).lean();
-
- results.sort((a, b) => new Date(b.updatedAt) - new Date(a.updatedAt));
-
- let filtered = results;
- if (cursor && cursor !== 'start') {
- const cursorDate = new Date(cursor);
- filtered = results.filter((convo) => new Date(convo.updatedAt) < cursorDate);
- }
-
- const limited = filtered.slice(0, limit + 1);
- let nextCursor = null;
- if (limited.length > limit) {
- limited.pop(); // Remove extra item used to detect next page
- // Create cursor from the last RETURNED item (not the popped one)
- nextCursor = limited[limited.length - 1].updatedAt.toISOString();
- }
-
- const convoMap = {};
- limited.forEach((convo) => {
- convoMap[convo.conversationId] = convo;
- });
-
- return { conversations: limited, nextCursor, convoMap };
- } catch (error) {
- logger.error('[getConvosQueried] Error getting conversations', error);
- throw new Error('Error fetching conversations');
- }
- },
- getConvo,
- /* chore: this method is not properly error handled */
- getConvoTitle: async (user, conversationId) => {
- try {
- const convo = await getConvo(user, conversationId);
- /* ChatGPT Browser was triggering error here due to convo being saved later */
- if (convo && !convo.title) {
- return null;
- } else {
- // TypeError: Cannot read properties of null (reading 'title')
- return convo?.title || 'New Chat';
- }
- } catch (error) {
- logger.error('[getConvoTitle] Error getting conversation title', error);
- throw new Error('Error getting conversation title');
- }
- },
- /**
- * Asynchronously deletes conversations and associated messages for a given user and filter.
- *
- * @async
- * @function
- * @param {string|ObjectId} user - The user's ID.
- * @param {Object} filter - Additional filter criteria for the conversations to be deleted.
- * @returns {Promise<{ n: number, ok: number, deletedCount: number, messages: { n: number, ok: number, deletedCount: number } }>}
- * An object containing the count of deleted conversations and associated messages.
- * @throws {Error} Throws an error if there's an issue with the database operations.
- *
- * @example
- * const user = 'someUserId';
- * const filter = { someField: 'someValue' };
- * const result = await deleteConvos(user, filter);
- * logger.error(result); // { n: 5, ok: 1, deletedCount: 5, messages: { n: 10, ok: 1, deletedCount: 10 } }
- */
- deleteConvos: async (user, filter) => {
- try {
- const userFilter = { ...filter, user };
- const conversations = await Conversation.find(userFilter).select('conversationId');
- const conversationIds = conversations.map((c) => c.conversationId);
-
- if (!conversationIds.length) {
- throw new Error('Conversation not found or already deleted.');
- }
-
- const deleteConvoResult = await Conversation.deleteMany(userFilter);
-
- const deleteMessagesResult = await deleteMessages({
- conversationId: { $in: conversationIds },
- user,
- });
-
- return { ...deleteConvoResult, messages: deleteMessagesResult };
- } catch (error) {
- logger.error('[deleteConvos] Error deleting conversations and messages', error);
- throw error;
- }
- },
-};
diff --git a/api/models/ConversationTag.js b/api/models/ConversationTag.js
deleted file mode 100644
index 99d0608a66..0000000000
--- a/api/models/ConversationTag.js
+++ /dev/null
@@ -1,284 +0,0 @@
-const { logger } = require('@librechat/data-schemas');
-const { ConversationTag, Conversation } = require('~/db/models');
-
-/**
- * Retrieves all conversation tags for a user.
- * @param {string} user - The user ID.
- * @returns {Promise<Array>} An array of conversation tags.
- */
-const getConversationTags = async (user) => {
- try {
- return await ConversationTag.find({ user }).sort({ position: 1 }).lean();
- } catch (error) {
- logger.error('[getConversationTags] Error getting conversation tags', error);
- throw new Error('Error getting conversation tags');
- }
-};
-
-/**
- * Creates a new conversation tag.
- * @param {string} user - The user ID.
- * @param {Object} data - The tag data.
- * @param {string} data.tag - The tag name.
- * @param {string} [data.description] - The tag description.
- * @param {boolean} [data.addToConversation] - Whether to add the tag to a conversation.
- * @param {string} [data.conversationId] - The conversation ID to add the tag to.
- * @returns {Promise<Object>} The created tag.
- */
-const createConversationTag = async (user, data) => {
- try {
- const { tag, description, addToConversation, conversationId } = data;
-
- const existingTag = await ConversationTag.findOne({ user, tag }).lean();
- if (existingTag) {
- return existingTag;
- }
-
- const maxPosition = await ConversationTag.findOne({ user }).sort('-position').lean();
- const position = (maxPosition?.position || 0) + 1;
-
- const newTag = await ConversationTag.findOneAndUpdate(
- { tag, user },
- {
- tag,
- user,
- count: addToConversation ? 1 : 0,
- position,
- description,
- $setOnInsert: { createdAt: new Date() },
- },
- {
- new: true,
- upsert: true,
- lean: true,
- },
- );
-
- if (addToConversation && conversationId) {
- await Conversation.findOneAndUpdate(
- { user, conversationId },
- { $addToSet: { tags: tag } },
- { new: true },
- );
- }
-
- return newTag;
- } catch (error) {
- logger.error('[createConversationTag] Error creating conversation tag', error);
- throw new Error('Error creating conversation tag');
- }
-};
-
-/**
- * Updates an existing conversation tag.
- * @param {string} user - The user ID.
- * @param {string} oldTag - The current tag name.
- * @param {Object} data - The updated tag data.
- * @param {string} [data.tag] - The new tag name.
- * @param {string} [data.description] - The updated description.
- * @param {number} [data.position] - The new position.
- * @returns {Promise<Object>} The updated tag.
- */
-const updateConversationTag = async (user, oldTag, data) => {
- try {
- const { tag: newTag, description, position } = data;
-
- const existingTag = await ConversationTag.findOne({ user, tag: oldTag }).lean();
- if (!existingTag) {
- return null;
- }
-
- if (newTag && newTag !== oldTag) {
- const tagAlreadyExists = await ConversationTag.findOne({ user, tag: newTag }).lean();
- if (tagAlreadyExists) {
- throw new Error('Tag already exists');
- }
-
- await Conversation.updateMany({ user, tags: oldTag }, { $set: { 'tags.$': newTag } });
- }
-
- const updateData = {};
- if (newTag) {
- updateData.tag = newTag;
- }
- if (description !== undefined) {
- updateData.description = description;
- }
- if (position !== undefined) {
- await adjustPositions(user, existingTag.position, position);
- updateData.position = position;
- }
-
- return await ConversationTag.findOneAndUpdate({ user, tag: oldTag }, updateData, {
- new: true,
- lean: true,
- });
- } catch (error) {
- logger.error('[updateConversationTag] Error updating conversation tag', error);
- throw new Error('Error updating conversation tag');
- }
-};
-
-/**
- * Adjusts positions of tags when a tag's position is changed.
- * @param {string} user - The user ID.
- * @param {number} oldPosition - The old position of the tag.
- * @param {number} newPosition - The new position of the tag.
- * @returns {Promise<void>}
- */
-const adjustPositions = async (user, oldPosition, newPosition) => {
- if (oldPosition === newPosition) {
- return;
- }
-
- const update = oldPosition < newPosition ? { $inc: { position: -1 } } : { $inc: { position: 1 } };
- const position =
- oldPosition < newPosition
- ? {
- $gt: Math.min(oldPosition, newPosition),
- $lte: Math.max(oldPosition, newPosition),
- }
- : {
- $gte: Math.min(oldPosition, newPosition),
- $lt: Math.max(oldPosition, newPosition),
- };
-
- await ConversationTag.updateMany(
- {
- user,
- position,
- },
- update,
- );
-};
-
-/**
- * Deletes a conversation tag.
- * @param {string} user - The user ID.
- * @param {string} tag - The tag to delete.
- * @returns {Promise<Object>} The deleted tag.
- */
-const deleteConversationTag = async (user, tag) => {
- try {
- const deletedTag = await ConversationTag.findOneAndDelete({ user, tag }).lean();
- if (!deletedTag) {
- return null;
- }
-
- await Conversation.updateMany({ user, tags: tag }, { $pullAll: { tags: [tag] } });
-
- await ConversationTag.updateMany(
- { user, position: { $gt: deletedTag.position } },
- { $inc: { position: -1 } },
- );
-
- return deletedTag;
- } catch (error) {
- logger.error('[deleteConversationTag] Error deleting conversation tag', error);
- throw new Error('Error deleting conversation tag');
- }
-};
-
-/**
- * Updates tags for a specific conversation.
- * @param {string} user - The user ID.
- * @param {string} conversationId - The conversation ID.
- * @param {string[]} tags - The new set of tags for the conversation.
- * @returns {Promise<string[]>} The updated list of tags for the conversation.
- */
-const updateTagsForConversation = async (user, conversationId, tags) => {
- try {
- const conversation = await Conversation.findOne({ user, conversationId }).lean();
- if (!conversation) {
- throw new Error('Conversation not found');
- }
-
- const oldTags = new Set(conversation.tags);
- const newTags = new Set(tags);
-
- const addedTags = [...newTags].filter((tag) => !oldTags.has(tag));
- const removedTags = [...oldTags].filter((tag) => !newTags.has(tag));
-
- const bulkOps = [];
-
- for (const tag of addedTags) {
- bulkOps.push({
- updateOne: {
- filter: { user, tag },
- update: { $inc: { count: 1 } },
- upsert: true,
- },
- });
- }
-
- for (const tag of removedTags) {
- bulkOps.push({
- updateOne: {
- filter: { user, tag },
- update: { $inc: { count: -1 } },
- },
- });
- }
-
- if (bulkOps.length > 0) {
- await ConversationTag.bulkWrite(bulkOps);
- }
-
- const updatedConversation = (
- await Conversation.findOneAndUpdate(
- { user, conversationId },
- { $set: { tags: [...newTags] } },
- { new: true },
- )
- ).toObject();
-
- return updatedConversation.tags;
- } catch (error) {
- logger.error('[updateTagsForConversation] Error updating tags', error);
- throw new Error('Error updating tags for conversation');
- }
-};
-
-/**
- * Increments tag counts for existing tags only.
- * @param {string} user - The user ID.
- * @param {string[]} tags - Array of tag names to increment
- * @returns {Promise<void>}
- */
-const bulkIncrementTagCounts = async (user, tags) => {
- if (!tags || tags.length === 0) {
- return;
- }
-
- try {
- const uniqueTags = [...new Set(tags.filter(Boolean))];
- if (uniqueTags.length === 0) {
- return;
- }
-
- const bulkOps = uniqueTags.map((tag) => ({
- updateOne: {
- filter: { user, tag },
- update: { $inc: { count: 1 } },
- },
- }));
-
- const result = await ConversationTag.bulkWrite(bulkOps);
- if (result && result.modifiedCount > 0) {
- logger.debug(
- `user: ${user} | Incremented tag counts - modified ${result.modifiedCount} tags`,
- );
- }
- } catch (error) {
- logger.error('[bulkIncrementTagCounts] Error incrementing tag counts', error);
- }
-};
-
-module.exports = {
- getConversationTags,
- createConversationTag,
- updateConversationTag,
- deleteConversationTag,
- bulkIncrementTagCounts,
- updateTagsForConversation,
-};
diff --git a/api/models/File.js b/api/models/File.js
deleted file mode 100644
index 1a01ef12f9..0000000000
--- a/api/models/File.js
+++ /dev/null
@@ -1,250 +0,0 @@
-const { logger } = require('@librechat/data-schemas');
-const { EToolResources, FileContext } = require('librechat-data-provider');
-const { File } = require('~/db/models');
-
-/**
- * Finds a file by its file_id with additional query options.
- * @param {string} file_id - The unique identifier of the file.
- * @param {object} options - Query options for filtering, projection, etc.
- * @returns {Promise<MongoFile>} A promise that resolves to the file document or null.
- */
-const findFileById = async (file_id, options = {}) => {
- return await File.findOne({ file_id, ...options }).lean();
-};
-
-/**
- * Retrieves files matching a given filter, sorted by the most recently updated.
- * @param {Object} filter - The filter criteria to apply.
- * @param {Object} [_sortOptions] - Optional sort parameters.
- * @param {Object|String} [selectFields={ text: 0 }] - Fields to include/exclude in the query results.
- * Default excludes the 'text' field.
- * @returns {Promise<Array<MongoFile>>} A promise that resolves to an array of file documents.
- */
-const getFiles = async (filter, _sortOptions, selectFields = { text: 0 }) => {
- const sortOptions = { updatedAt: -1, ..._sortOptions };
- return await File.find(filter).select(selectFields).sort(sortOptions).lean();
-};
-
-/**
- * Retrieves tool files (files that are embedded or have a fileIdentifier) from an array of file IDs.
- * Note: execute_code files are handled separately by getCodeGeneratedFiles.
- * @param {string[]} fileIds - Array of file_id strings to search for
- * @param {Set<EToolResources>} toolResourceSet - Optional filter for tool resources
- * @returns {Promise<Array<MongoFile>>} Files that match the criteria
- */
-const getToolFilesByIds = async (fileIds, toolResourceSet) => {
- if (!fileIds || !fileIds.length || !toolResourceSet?.size) {
- return [];
- }
-
- try {
- const orConditions = [];
-
- if (toolResourceSet.has(EToolResources.context)) {
- orConditions.push({ text: { $exists: true, $ne: null }, context: FileContext.agents });
- }
- if (toolResourceSet.has(EToolResources.file_search)) {
- orConditions.push({ embedded: true });
- }
-
- if (orConditions.length === 0) {
- return [];
- }
-
- const filter = {
- file_id: { $in: fileIds },
- context: { $ne: FileContext.execute_code }, // Exclude code-generated files
- $or: orConditions,
- };
-
- const selectFields = { text: 0 };
- const sortOptions = { updatedAt: -1 };
-
- return await getFiles(filter, sortOptions, selectFields);
- } catch (error) {
- logger.error('[getToolFilesByIds] Error retrieving tool files:', error);
- throw new Error('Error retrieving tool files');
- }
-};
-
-/**
- * Retrieves files generated by code execution for a given conversation.
- * These files are stored locally with fileIdentifier metadata for code env re-upload.
- * @param {string} conversationId - The conversation ID to search for
- * @param {string[]} [messageIds] - Optional array of messageIds to filter by (for linear thread filtering)
- * @returns {Promise<Array<MongoFile>>} Files generated by code execution in the conversation
- */
-const getCodeGeneratedFiles = async (conversationId, messageIds) => {
- if (!conversationId) {
- return [];
- }
-
- /** messageIds are required for proper thread filtering of code-generated files */
- if (!messageIds || messageIds.length === 0) {
- return [];
- }
-
- try {
- const filter = {
- conversationId,
- context: FileContext.execute_code,
- messageId: { $exists: true, $in: messageIds },
- 'metadata.fileIdentifier': { $exists: true },
- };
-
- const selectFields = { text: 0 };
- const sortOptions = { createdAt: 1 };
-
- return await getFiles(filter, sortOptions, selectFields);
- } catch (error) {
- logger.error('[getCodeGeneratedFiles] Error retrieving code generated files:', error);
- return [];
- }
-};
-
-/**
- * Retrieves user-uploaded execute_code files (not code-generated) by their file IDs.
- * These are files with fileIdentifier metadata but context is NOT execute_code (e.g., agents or message_attachment).
- * File IDs should be collected from message.files arrays in the current thread.
- * @param {string[]} fileIds - Array of file IDs to fetch (from message.files in the thread)
- * @returns {Promise<Array<MongoFile>>} User-uploaded execute_code files
- */
-const getUserCodeFiles = async (fileIds) => {
- if (!fileIds || fileIds.length === 0) {
- return [];
- }
-
- try {
- const filter = {
- file_id: { $in: fileIds },
- context: { $ne: FileContext.execute_code },
- 'metadata.fileIdentifier': { $exists: true },
- };
-
- const selectFields = { text: 0 };
- const sortOptions = { createdAt: 1 };
-
- return await getFiles(filter, sortOptions, selectFields);
- } catch (error) {
- logger.error('[getUserCodeFiles] Error retrieving user code files:', error);
- return [];
- }
-};
-
-/**
- * Creates a new file with a TTL of 1 hour.
- * @param {MongoFile} data - The file data to be created, must contain file_id.
- * @param {boolean} disableTTL - Whether to disable the TTL.
- * @returns {Promise<MongoFile>} A promise that resolves to the created file document.
- */
-const createFile = async (data, disableTTL) => {
- const fileData = {
- ...data,
- expiresAt: new Date(Date.now() + 3600 * 1000),
- };
-
- if (disableTTL) {
- delete fileData.expiresAt;
- }
-
- return await File.findOneAndUpdate({ file_id: data.file_id }, fileData, {
- new: true,
- upsert: true,
- }).lean();
-};
-
-/**
- * Updates a file identified by file_id with new data and removes the TTL.
- * @param {MongoFile} data - The data to update, must contain file_id.
- * @returns {Promise<MongoFile>} A promise that resolves to the updated file document.
- */
-const updateFile = async (data) => {
- const { file_id, ...update } = data;
- const updateOperation = {
- $set: update,
- $unset: { expiresAt: '' }, // Remove the expiresAt field to prevent TTL
- };
- return await File.findOneAndUpdate({ file_id }, updateOperation, { new: true }).lean();
-};
-
-/**
- * Increments the usage of a file identified by file_id.
- * @param {MongoFile} data - The data to update, must contain file_id and the increment value for usage.
- * @returns {Promise<MongoFile>} A promise that resolves to the updated file document.
- */
-const updateFileUsage = async (data) => {
- const { file_id, inc = 1 } = data;
- const updateOperation = {
- $inc: { usage: inc },
- $unset: { expiresAt: '', temp_file_id: '' },
- };
- return await File.findOneAndUpdate({ file_id }, updateOperation, { new: true }).lean();
-};
-
-/**
- * Deletes a file identified by file_id.
- * @param {string} file_id - The unique identifier of the file to delete.
- * @returns {Promise<MongoFile>} A promise that resolves to the deleted file document or null.
- */
-const deleteFile = async (file_id) => {
- return await File.findOneAndDelete({ file_id }).lean();
-};
-
-/**
- * Deletes a file identified by a filter.
- * @param {object} filter - The filter criteria to apply.
- * @returns {Promise<MongoFile>} A promise that resolves to the deleted file document or null.
- */
-const deleteFileByFilter = async (filter) => {
- return await File.findOneAndDelete(filter).lean();
-};
-
-/**
- * Deletes multiple files identified by an array of file_ids.
- * @param {Array<string>} file_ids - The unique identifiers of the files to delete.
- * @returns {Promise<Object>} A promise that resolves to the result of the deletion operation.
- */
-const deleteFiles = async (file_ids, user) => {
- let deleteQuery = { file_id: { $in: file_ids } };
- if (user) {
- deleteQuery = { user: user };
- }
- return await File.deleteMany(deleteQuery);
-};
-
-/**
- * Batch updates files with new signed URLs in MongoDB
- *
- * @param {MongoFile[]} updates - Array of updates in the format { file_id, filepath }
- * @returns {Promise<void>}
- */
-async function batchUpdateFiles(updates) {
- if (!updates || updates.length === 0) {
- return;
- }
-
- const bulkOperations = updates.map((update) => ({
- updateOne: {
- filter: { file_id: update.file_id },
- update: { $set: { filepath: update.filepath } },
- },
- }));
-
- const result = await File.bulkWrite(bulkOperations);
- logger.info(`Updated ${result.modifiedCount} files with new S3 URLs`);
-}
-
-module.exports = {
- findFileById,
- getFiles,
- getToolFilesByIds,
- getCodeGeneratedFiles,
- getUserCodeFiles,
- createFile,
- updateFile,
- updateFileUsage,
- deleteFile,
- deleteFiles,
- deleteFileByFilter,
- batchUpdateFiles,
-};
diff --git a/api/models/File.spec.js b/api/models/File.spec.js
deleted file mode 100644
index ecb2e21b08..0000000000
--- a/api/models/File.spec.js
+++ /dev/null
@@ -1,736 +0,0 @@
-const mongoose = require('mongoose');
-const { v4: uuidv4 } = require('uuid');
-const { MongoMemoryServer } = require('mongodb-memory-server');
-const { createModels, createMethods } = require('@librechat/data-schemas');
-const {
- SystemRoles,
- ResourceType,
- AccessRoleIds,
- PrincipalType,
-} = require('librechat-data-provider');
-const { grantPermission } = require('~/server/services/PermissionService');
-const { createAgent } = require('./Agent');
-
-let File;
-let Agent;
-let AclEntry;
-let User;
-let modelsToCleanup = [];
-let methods;
-let getFiles;
-let createFile;
-let seedDefaultRoles;
-
-describe('File Access Control', () => {
- let mongoServer;
-
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- await mongoose.connect(mongoUri);
-
- // Initialize all models
- const models = createModels(mongoose);
-
- // Track which models we're adding
- modelsToCleanup = Object.keys(models);
-
- // Register models on mongoose.models so methods can access them
- const dbModels = require('~/db/models');
- Object.assign(mongoose.models, dbModels);
-
- File = dbModels.File;
- Agent = dbModels.Agent;
- AclEntry = dbModels.AclEntry;
- User = dbModels.User;
-
- // Create methods from data-schemas (includes file methods)
- methods = createMethods(mongoose);
- getFiles = methods.getFiles;
- createFile = methods.createFile;
- seedDefaultRoles = methods.seedDefaultRoles;
-
- // Seed default roles
- await seedDefaultRoles();
- });
-
- afterAll(async () => {
- // Clean up all collections before disconnecting
- const collections = mongoose.connection.collections;
- for (const key in collections) {
- await collections[key].deleteMany({});
- }
-
- // Clear only the models we added
- for (const modelName of modelsToCleanup) {
- if (mongoose.models[modelName]) {
- delete mongoose.models[modelName];
- }
- }
-
- await mongoose.disconnect();
- await mongoServer.stop();
- });
-
- beforeEach(async () => {
- await File.deleteMany({});
- await Agent.deleteMany({});
- await AclEntry.deleteMany({});
- await User.deleteMany({});
- // Don't delete AccessRole as they are seeded defaults needed for tests
- });
-
- describe('hasAccessToFilesViaAgent', () => {
- it('should efficiently check access for multiple files at once', async () => {
- const userId = new mongoose.Types.ObjectId();
- const authorId = new mongoose.Types.ObjectId();
- const agentId = uuidv4();
- const fileIds = [uuidv4(), uuidv4(), uuidv4(), uuidv4()];
-
- // Create users
- await User.create({
- _id: userId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- await User.create({
- _id: authorId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- // Create files
- for (const fileId of fileIds) {
- await createFile({
- user: authorId,
- file_id: fileId,
- filename: `file-${fileId}.txt`,
- filepath: `/uploads/${fileId}`,
- });
- }
-
- // Create agent with only first two files attached
- const agent = await createAgent({
- id: agentId,
- name: 'Test Agent',
- author: authorId,
- model: 'gpt-4',
- provider: 'openai',
- tool_resources: {
- file_search: {
- file_ids: [fileIds[0], fileIds[1]],
- },
- },
- });
-
- // Grant EDIT permission to user on the agent
- await grantPermission({
- principalType: PrincipalType.USER,
- principalId: userId,
- resourceType: ResourceType.AGENT,
- resourceId: agent._id,
- accessRoleId: AccessRoleIds.AGENT_EDITOR,
- grantedBy: authorId,
- });
-
- // Check access for all files
- const { hasAccessToFilesViaAgent } = require('~/server/services/Files/permissions');
- const accessMap = await hasAccessToFilesViaAgent({
- userId: userId,
- role: SystemRoles.USER,
- fileIds,
- agentId: agent.id, // Use agent.id which is the custom UUID
- });
-
- // Should have access only to the first two files
- expect(accessMap.get(fileIds[0])).toBe(true);
- expect(accessMap.get(fileIds[1])).toBe(true);
- expect(accessMap.get(fileIds[2])).toBe(false);
- expect(accessMap.get(fileIds[3])).toBe(false);
- });
-
- it('should only grant author access to files attached to the agent', async () => {
- const authorId = new mongoose.Types.ObjectId();
- const agentId = uuidv4();
- const fileIds = [uuidv4(), uuidv4(), uuidv4()];
-
- await User.create({
- _id: authorId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- await createAgent({
- id: agentId,
- name: 'Test Agent',
- author: authorId,
- model: 'gpt-4',
- provider: 'openai',
- tool_resources: {
- file_search: {
- file_ids: [fileIds[0]],
- },
- },
- });
-
- const { hasAccessToFilesViaAgent } = require('~/server/services/Files/permissions');
- const accessMap = await hasAccessToFilesViaAgent({
- userId: authorId,
- role: SystemRoles.USER,
- fileIds,
- agentId,
- });
-
- expect(accessMap.get(fileIds[0])).toBe(true);
- expect(accessMap.get(fileIds[1])).toBe(false);
- expect(accessMap.get(fileIds[2])).toBe(false);
- });
-
- it('should deny all access when agent has no tool_resources', async () => {
- const authorId = new mongoose.Types.ObjectId();
- const agentId = uuidv4();
- const fileId = uuidv4();
-
- await User.create({
- _id: authorId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- await createAgent({
- id: agentId,
- name: 'Bare Agent',
- author: authorId,
- model: 'gpt-4',
- provider: 'openai',
- });
-
- const { hasAccessToFilesViaAgent } = require('~/server/services/Files/permissions');
- const accessMap = await hasAccessToFilesViaAgent({
- userId: authorId,
- role: SystemRoles.USER,
- fileIds: [fileId],
- agentId,
- });
-
- expect(accessMap.get(fileId)).toBe(false);
- });
-
- it('should grant access to files across multiple resource types', async () => {
- const authorId = new mongoose.Types.ObjectId();
- const agentId = uuidv4();
- const fileIds = [uuidv4(), uuidv4(), uuidv4()];
-
- await User.create({
- _id: authorId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- await createAgent({
- id: agentId,
- name: 'Multi Resource Agent',
- author: authorId,
- model: 'gpt-4',
- provider: 'openai',
- tool_resources: {
- file_search: {
- file_ids: [fileIds[0]],
- },
- execute_code: {
- file_ids: [fileIds[1]],
- },
- },
- });
-
- const { hasAccessToFilesViaAgent } = require('~/server/services/Files/permissions');
- const accessMap = await hasAccessToFilesViaAgent({
- userId: authorId,
- role: SystemRoles.USER,
- fileIds,
- agentId,
- });
-
- expect(accessMap.get(fileIds[0])).toBe(true);
- expect(accessMap.get(fileIds[1])).toBe(true);
- expect(accessMap.get(fileIds[2])).toBe(false);
- });
-
- it('should grant author access to attached files when isDelete is true', async () => {
- const authorId = new mongoose.Types.ObjectId();
- const agentId = uuidv4();
- const attachedFileId = uuidv4();
- const unattachedFileId = uuidv4();
-
- await User.create({
- _id: authorId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- await createAgent({
- id: agentId,
- name: 'Delete Test Agent',
- author: authorId,
- model: 'gpt-4',
- provider: 'openai',
- tool_resources: {
- file_search: {
- file_ids: [attachedFileId],
- },
- },
- });
-
- const { hasAccessToFilesViaAgent } = require('~/server/services/Files/permissions');
- const accessMap = await hasAccessToFilesViaAgent({
- userId: authorId,
- role: SystemRoles.USER,
- fileIds: [attachedFileId, unattachedFileId],
- agentId,
- isDelete: true,
- });
-
- expect(accessMap.get(attachedFileId)).toBe(true);
- expect(accessMap.get(unattachedFileId)).toBe(false);
- });
-
- it('should handle non-existent agent gracefully', async () => {
- const userId = new mongoose.Types.ObjectId();
- const fileIds = [uuidv4(), uuidv4()];
-
- // Create user
- await User.create({
- _id: userId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- const { hasAccessToFilesViaAgent } = require('~/server/services/Files/permissions');
- const accessMap = await hasAccessToFilesViaAgent({
- userId: userId,
- role: SystemRoles.USER,
- fileIds,
- agentId: 'non-existent-agent',
- });
-
- // Should have no access to any files
- expect(accessMap.get(fileIds[0])).toBe(false);
- expect(accessMap.get(fileIds[1])).toBe(false);
- });
-
- it('should deny access when user only has VIEW permission and needs access for deletion', async () => {
- const userId = new mongoose.Types.ObjectId();
- const authorId = new mongoose.Types.ObjectId();
- const agentId = uuidv4();
- const fileIds = [uuidv4(), uuidv4()];
-
- // Create users
- await User.create({
- _id: userId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- await User.create({
- _id: authorId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- // Create agent with files
- const agent = await createAgent({
- id: agentId,
- name: 'View-Only Agent',
- author: authorId,
- model: 'gpt-4',
- provider: 'openai',
- tool_resources: {
- file_search: {
- file_ids: fileIds,
- },
- },
- });
-
- // Grant only VIEW permission to user on the agent
- await grantPermission({
- principalType: PrincipalType.USER,
- principalId: userId,
- resourceType: ResourceType.AGENT,
- resourceId: agent._id,
- accessRoleId: AccessRoleIds.AGENT_VIEWER,
- grantedBy: authorId,
- });
-
- // Check access for files
- const { hasAccessToFilesViaAgent } = require('~/server/services/Files/permissions');
- const accessMap = await hasAccessToFilesViaAgent({
- userId: userId,
- role: SystemRoles.USER,
- fileIds,
- agentId,
- isDelete: true,
- });
-
- // Should have no access to any files when only VIEW permission
- expect(accessMap.get(fileIds[0])).toBe(false);
- expect(accessMap.get(fileIds[1])).toBe(false);
- });
-
- it('should grant access when user has VIEW permission', async () => {
- const userId = new mongoose.Types.ObjectId();
- const authorId = new mongoose.Types.ObjectId();
- const agentId = uuidv4();
- const fileIds = [uuidv4(), uuidv4()];
-
- // Create users
- await User.create({
- _id: userId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- await User.create({
- _id: authorId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- // Create agent with files
- const agent = await createAgent({
- id: agentId,
- name: 'View-Only Agent',
- author: authorId,
- model: 'gpt-4',
- provider: 'openai',
- tool_resources: {
- file_search: {
- file_ids: fileIds,
- },
- },
- });
-
- // Grant only VIEW permission to user on the agent
- await grantPermission({
- principalType: PrincipalType.USER,
- principalId: userId,
- resourceType: ResourceType.AGENT,
- resourceId: agent._id,
- accessRoleId: AccessRoleIds.AGENT_VIEWER,
- grantedBy: authorId,
- });
-
- // Check access for files
- const { hasAccessToFilesViaAgent } = require('~/server/services/Files/permissions');
- const accessMap = await hasAccessToFilesViaAgent({
- userId: userId,
- role: SystemRoles.USER,
- fileIds,
- agentId,
- });
-
- expect(accessMap.get(fileIds[0])).toBe(true);
- expect(accessMap.get(fileIds[1])).toBe(true);
- });
- });
-
- describe('getFiles with agent access control', () => {
- test('should return files owned by user and files accessible through agent', async () => {
- const authorId = new mongoose.Types.ObjectId();
- const userId = new mongoose.Types.ObjectId();
- const agentId = `agent_${uuidv4()}`;
- const ownedFileId = `file_${uuidv4()}`;
- const sharedFileId = `file_${uuidv4()}`;
- const inaccessibleFileId = `file_${uuidv4()}`;
-
- // Create users
- await User.create({
- _id: userId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- await User.create({
- _id: authorId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- // Create agent with shared file
- const agent = await createAgent({
- id: agentId,
- name: 'Shared Agent',
- provider: 'test',
- model: 'test-model',
- author: authorId,
- tool_resources: {
- file_search: {
- file_ids: [sharedFileId],
- },
- },
- });
-
- // Grant EDIT permission to user on the agent
- await grantPermission({
- principalType: PrincipalType.USER,
- principalId: userId,
- resourceType: ResourceType.AGENT,
- resourceId: agent._id,
- accessRoleId: AccessRoleIds.AGENT_EDITOR,
- grantedBy: authorId,
- });
-
- // Create files
- await createFile({
- file_id: ownedFileId,
- user: userId,
- filename: 'owned.txt',
- filepath: '/uploads/owned.txt',
- type: 'text/plain',
- bytes: 100,
- });
-
- await createFile({
- file_id: sharedFileId,
- user: authorId,
- filename: 'shared.txt',
- filepath: '/uploads/shared.txt',
- type: 'text/plain',
- bytes: 200,
- embedded: true,
- });
-
- await createFile({
- file_id: inaccessibleFileId,
- user: authorId,
- filename: 'inaccessible.txt',
- filepath: '/uploads/inaccessible.txt',
- type: 'text/plain',
- bytes: 300,
- });
-
- // Get all files first
- const allFiles = await getFiles(
- { file_id: { $in: [ownedFileId, sharedFileId, inaccessibleFileId] } },
- null,
- { text: 0 },
- );
-
- // Then filter by access control
- const { filterFilesByAgentAccess } = require('~/server/services/Files/permissions');
- const files = await filterFilesByAgentAccess({
- files: allFiles,
- userId: userId,
- role: SystemRoles.USER,
- agentId,
- });
-
- expect(files).toHaveLength(2);
- expect(files.map((f) => f.file_id)).toContain(ownedFileId);
- expect(files.map((f) => f.file_id)).toContain(sharedFileId);
- expect(files.map((f) => f.file_id)).not.toContain(inaccessibleFileId);
- });
-
- test('should return all files when no userId/agentId provided', async () => {
- const userId = new mongoose.Types.ObjectId();
- const fileId1 = `file_${uuidv4()}`;
- const fileId2 = `file_${uuidv4()}`;
-
- await createFile({
- file_id: fileId1,
- user: userId,
- filename: 'file1.txt',
- filepath: '/uploads/file1.txt',
- type: 'text/plain',
- bytes: 100,
- });
-
- await createFile({
- file_id: fileId2,
- user: new mongoose.Types.ObjectId(),
- filename: 'file2.txt',
- filepath: '/uploads/file2.txt',
- type: 'text/plain',
- bytes: 200,
- });
-
- const files = await getFiles({ file_id: { $in: [fileId1, fileId2] } });
- expect(files).toHaveLength(2);
- });
- });
-
- describe('Role-based file permissions', () => {
- it('should optimize permission checks when role is provided', async () => {
- const userId = new mongoose.Types.ObjectId();
- const authorId = new mongoose.Types.ObjectId();
- const agentId = uuidv4();
- const fileIds = [uuidv4(), uuidv4()];
-
- // Create users
- await User.create({
- _id: userId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- role: 'ADMIN', // User has ADMIN role
- });
-
- await User.create({
- _id: authorId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- // Create files
- for (const fileId of fileIds) {
- await createFile({
- file_id: fileId,
- user: authorId,
- filename: `${fileId}.txt`,
- filepath: `/uploads/${fileId}.txt`,
- type: 'text/plain',
- bytes: 100,
- });
- }
-
- // Create agent with files
- const agent = await createAgent({
- id: agentId,
- name: 'Test Agent',
- author: authorId,
- model: 'gpt-4',
- provider: 'openai',
- tool_resources: {
- file_search: {
- file_ids: fileIds,
- },
- },
- });
-
- // Grant permission to ADMIN role
- await grantPermission({
- principalType: PrincipalType.ROLE,
- principalId: 'ADMIN',
- resourceType: ResourceType.AGENT,
- resourceId: agent._id,
- accessRoleId: AccessRoleIds.AGENT_EDITOR,
- grantedBy: authorId,
- });
-
- // Check access with role provided (should avoid DB query)
- const { hasAccessToFilesViaAgent } = require('~/server/services/Files/permissions');
- const accessMapWithRole = await hasAccessToFilesViaAgent({
- userId: userId,
- role: 'ADMIN',
- fileIds,
- agentId: agent.id,
- });
-
- // User should have access through their ADMIN role
- expect(accessMapWithRole.get(fileIds[0])).toBe(true);
- expect(accessMapWithRole.get(fileIds[1])).toBe(true);
-
- // Check access without role (will query DB to get user's role)
- const accessMapWithoutRole = await hasAccessToFilesViaAgent({
- userId: userId,
- fileIds,
- agentId: agent.id,
- });
-
- // Should have same result
- expect(accessMapWithoutRole.get(fileIds[0])).toBe(true);
- expect(accessMapWithoutRole.get(fileIds[1])).toBe(true);
- });
-
- it('should deny access when user role changes', async () => {
- const userId = new mongoose.Types.ObjectId();
- const authorId = new mongoose.Types.ObjectId();
- const agentId = uuidv4();
- const fileId = uuidv4();
-
- // Create users
- await User.create({
- _id: userId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- role: 'EDITOR',
- });
-
- await User.create({
- _id: authorId,
- email: '[email protected]',
- emailVerified: true,
- provider: 'local',
- });
-
- // Create file
- await createFile({
- file_id: fileId,
- user: authorId,
- filename: 'test.txt',
- filepath: '/uploads/test.txt',
- type: 'text/plain',
- bytes: 100,
- });
-
- // Create agent
- const agent = await createAgent({
- id: agentId,
- name: 'Test Agent',
- author: authorId,
- model: 'gpt-4',
- provider: 'openai',
- tool_resources: {
- file_search: {
- file_ids: [fileId],
- },
- },
- });
-
- // Grant permission to EDITOR role only
- await grantPermission({
- principalType: PrincipalType.ROLE,
- principalId: 'EDITOR',
- resourceType: ResourceType.AGENT,
- resourceId: agent._id,
- accessRoleId: AccessRoleIds.AGENT_EDITOR,
- grantedBy: authorId,
- });
-
- const { hasAccessToFilesViaAgent } = require('~/server/services/Files/permissions');
-
- // Check with EDITOR role - should have access
- const accessAsEditor = await hasAccessToFilesViaAgent({
- userId: userId,
- role: 'EDITOR',
- fileIds: [fileId],
- agentId: agent.id,
- });
- expect(accessAsEditor.get(fileId)).toBe(true);
-
- // Simulate role change to USER - should lose access
- const accessAsUser = await hasAccessToFilesViaAgent({
- userId: userId,
- role: SystemRoles.USER,
- fileIds: [fileId],
- agentId: agent.id,
- });
- expect(accessAsUser.get(fileId)).toBe(false);
- });
- });
-});
diff --git a/api/models/Message.js b/api/models/Message.js
deleted file mode 100644
index 8fe04f6f54..0000000000
--- a/api/models/Message.js
+++ /dev/null
@@ -1,372 +0,0 @@
-const { z } = require('zod');
-const { logger } = require('@librechat/data-schemas');
-const { createTempChatExpirationDate } = require('@librechat/api');
-const { Message } = require('~/db/models');
-
-const idSchema = z.string().uuid();
-
-/**
- * Saves a message in the database.
- *
- * @async
- * @function saveMessage
- * @param {ServerRequest} req - The request object containing user information.
- * @param {Object} params - The message data object.
- * @param {string} params.endpoint - The endpoint where the message originated.
- * @param {string} params.iconURL - The URL of the sender's icon.
- * @param {string} params.messageId - The unique identifier for the message.
- * @param {string} params.newMessageId - The new unique identifier for the message (if applicable).
- * @param {string} params.conversationId - The identifier of the conversation.
- * @param {string} [params.parentMessageId] - The identifier of the parent message, if any.
- * @param {string} params.sender - The identifier of the sender.
- * @param {string} params.text - The text content of the message.
- * @param {boolean} params.isCreatedByUser - Indicates if the message was created by the user.
- * @param {string} [params.error] - Any error associated with the message.
- * @param {boolean} [params.unfinished] - Indicates if the message is unfinished.
- * @param {Object[]} [params.files] - An array of files associated with the message.
- * @param {string} [params.finish_reason] - Reason for finishing the message.
- * @param {number} [params.tokenCount] - The number of tokens in the message.
- * @param {string} [params.plugin] - Plugin associated with the message.
- * @param {string[]} [params.plugins] - An array of plugins associated with the message.
- * @param {string} [params.model] - The model used to generate the message.
- * @param {Object} [metadata] - Additional metadata for this operation
- * @param {string} [metadata.context] - The context of the operation
- * @returns {Promise<TMessage>} The updated or newly inserted message document.
- * @throws {Error} If there is an error in saving the message.
- */
-async function saveMessage(req, params, metadata) {
- if (!req?.user?.id) {
- throw new Error('User not authenticated');
- }
-
- const validConvoId = idSchema.safeParse(params.conversationId);
- if (!validConvoId.success) {
- logger.warn(`Invalid conversation ID: ${params.conversationId}`);
- logger.info(`---\`saveMessage\` context: ${metadata?.context}`);
- logger.info(`---Invalid conversation ID Params: ${JSON.stringify(params, null, 2)}`);
- return;
- }
-
- try {
- const update = {
- ...params,
- user: req.user.id,
- messageId: params.newMessageId || params.messageId,
- };
-
- if (req?.body?.isTemporary) {
- try {
- const appConfig = req.config;
- update.expiredAt = createTempChatExpirationDate(appConfig?.interfaceConfig);
- } catch (err) {
- logger.error('Error creating temporary chat expiration date:', err);
- logger.info(`---\`saveMessage\` context: ${metadata?.context}`);
- update.expiredAt = null;
- }
- } else {
- update.expiredAt = null;
- }
-
- if (update.tokenCount != null && isNaN(update.tokenCount)) {
- logger.warn(
- `Resetting invalid \`tokenCount\` for message \`${params.messageId}\`: ${update.tokenCount}`,
- );
- logger.info(`---\`saveMessage\` context: ${metadata?.context}`);
- update.tokenCount = 0;
- }
- const message = await Message.findOneAndUpdate(
- { messageId: params.messageId, user: req.user.id },
- update,
- { upsert: true, new: true },
- );
-
- return message.toObject();
- } catch (err) {
- logger.error('Error saving message:', err);
- logger.info(`---\`saveMessage\` context: ${metadata?.context}`);
-
- // Check if this is a duplicate key error (MongoDB error code 11000)
- if (err.code === 11000 && err.message.includes('duplicate key error')) {
- // Log the duplicate key error but don't crash the application
- logger.warn(`Duplicate messageId detected: ${params.messageId}. Continuing execution.`);
-
- try {
- // Try to find the existing message with this ID
- const existingMessage = await Message.findOne({
- messageId: params.messageId,
- user: req.user.id,
- });
-
- // If we found it, return it
- if (existingMessage) {
- return existingMessage.toObject();
- }
-
- // If we can't find it (unlikely but possible in race conditions)
- return {
- ...params,
- messageId: params.messageId,
- user: req.user.id,
- };
- } catch (findError) {
- // If the findOne also fails, log it but don't crash
- logger.warn(
- `Could not retrieve existing message with ID ${params.messageId}: ${findError.message}`,
- );
- return {
- ...params,
- messageId: params.messageId,
- user: req.user.id,
- };
- }
- }
-
- throw err; // Re-throw other errors
- }
-}
-
-/**
- * Saves multiple messages in the database in bulk.
- *
- * @async
- * @function bulkSaveMessages
- * @param {Object[]} messages - An array of message objects to save.
- * @param {boolean} [overrideTimestamp=false] - Indicates whether to override the timestamps of the messages. Defaults to false.
- * @returns {Promise<Object>} The result of the bulk write operation.
- * @throws {Error} If there is an error in saving messages in bulk.
- */
-async function bulkSaveMessages(messages, overrideTimestamp = false) {
- try {
- const bulkOps = messages.map((message) => ({
- updateOne: {
- filter: { messageId: message.messageId },
- update: message,
- timestamps: !overrideTimestamp,
- upsert: true,
- },
- }));
- const result = await Message.bulkWrite(bulkOps);
- return result;
- } catch (err) {
- logger.error('Error saving messages in bulk:', err);
- throw err;
- }
-}
-
-/**
- * Records a message in the database.
- *
- * @async
- * @function recordMessage
- * @param {Object} params - The message data object.
- * @param {string} params.user - The identifier of the user.
- * @param {string} params.endpoint - The endpoint where the message originated.
- * @param {string} params.messageId - The unique identifier for the message.
- * @param {string} params.conversationId - The identifier of the conversation.
- * @param {string} [params.parentMessageId] - The identifier of the parent message, if any.
- * @param {Partial<TMessage>} rest - Any additional properties from the TMessage typedef not explicitly listed.
- * @returns {Promise<Object>} The updated or newly inserted message document.
- * @throws {Error} If there is an error in saving the message.
- */
-async function recordMessage({
- user,
- endpoint,
- messageId,
- conversationId,
- parentMessageId,
- ...rest
-}) {
- try {
- // No parsing of convoId as may use threadId
- const message = {
- user,
- endpoint,
- messageId,
- conversationId,
- parentMessageId,
- ...rest,
- };
-
- return await Message.findOneAndUpdate({ user, messageId }, message, {
- upsert: true,
- new: true,
- });
- } catch (err) {
- logger.error('Error recording message:', err);
- throw err;
- }
-}
-
-/**
- * Updates the text of a message.
- *
- * @async
- * @function updateMessageText
- * @param {Object} params - The update data object.
- * @param {Object} req - The request object.
- * @param {string} params.messageId - The unique identifier for the message.
- * @param {string} params.text - The new text content of the message.
- * @returns {Promise<void>}
- * @throws {Error} If there is an error in updating the message text.
- */
-async function updateMessageText(req, { messageId, text }) {
- try {
- await Message.updateOne({ messageId, user: req.user.id }, { text });
- } catch (err) {
- logger.error('Error updating message text:', err);
- throw err;
- }
-}
-
-/**
- * Updates a message.
- *
- * @async
- * @function updateMessage
- * @param {Object} req - The request object.
- * @param {Object} message - The message object containing update data.
- * @param {string} message.messageId - The unique identifier for the message.
- * @param {string} [message.text] - The new text content of the message.
- * @param {Object[]} [message.files] - The files associated with the message.
- * @param {boolean} [message.isCreatedByUser] - Indicates if the message was created by the user.
- * @param {string} [message.sender] - The identifier of the sender.
- * @param {number} [message.tokenCount] - The number of tokens in the message.
- * @param {Object} [metadata] - The operation metadata
- * @param {string} [metadata.context] - The operation metadata
- * @returns {Promise<TMessage>} The updated message document.
- * @throws {Error} If there is an error in updating the message or if the message is not found.
- */
-async function updateMessage(req, message, metadata) {
- try {
- const { messageId, ...update } = message;
- const updatedMessage = await Message.findOneAndUpdate(
- { messageId, user: req.user.id },
- update,
- {
- new: true,
- },
- );
-
- if (!updatedMessage) {
- throw new Error('Message not found or user not authorized.');
- }
-
- return {
- messageId: updatedMessage.messageId,
- conversationId: updatedMessage.conversationId,
- parentMessageId: updatedMessage.parentMessageId,
- sender: updatedMessage.sender,
- text: updatedMessage.text,
- isCreatedByUser: updatedMessage.isCreatedByUser,
- tokenCount: updatedMessage.tokenCount,
- feedback: updatedMessage.feedback,
- };
- } catch (err) {
- logger.error('Error updating message:', err);
- if (metadata && metadata?.context) {
- logger.info(`---\`updateMessage\` context: ${metadata.context}`);
- }
- throw err;
- }
-}
-
-/**
- * Deletes messages in a conversation since a specific message.
- *
- * @async
- * @function deleteMessagesSince
- * @param {Object} params - The parameters object.
- * @param {Object} req - The request object.
- * @param {string} params.messageId - The unique identifier for the message.
- * @param {string} params.conversationId - The identifier of the conversation.
- * @returns {Promise<Number>} The number of deleted messages.
- * @throws {Error} If there is an error in deleting messages.
- */
-async function deleteMessagesSince(req, { messageId, conversationId }) {
- try {
- const message = await Message.findOne({ messageId, user: req.user.id }).lean();
-
- if (message) {
- const query = Message.find({ conversationId, user: req.user.id });
- return await query.deleteMany({
- createdAt: { $gt: message.createdAt },
- });
- }
- return undefined;
- } catch (err) {
- logger.error('Error deleting messages:', err);
- throw err;
- }
-}
-
-/**
- * Retrieves messages from the database.
- * @async
- * @function getMessages
- * @param {Record<string, unknown>} filter - The filter criteria.
- * @param {string | undefined} [select] - The fields to select.
- * @returns {Promise<TMessage[]>} The messages that match the filter criteria.
- * @throws {Error} If there is an error in retrieving messages.
- */
-async function getMessages(filter, select) {
- try {
- if (select) {
- return await Message.find(filter).select(select).sort({ createdAt: 1 }).lean();
- }
-
- return await Message.find(filter).sort({ createdAt: 1 }).lean();
- } catch (err) {
- logger.error('Error getting messages:', err);
- throw err;
- }
-}
-
-/**
- * Retrieves a single message from the database.
- * @async
- * @function getMessage
- * @param {{ user: string, messageId: string }} params - The search parameters
- * @returns {Promise<TMessage | null>} The message that matches the criteria or null if not found
- * @throws {Error} If there is an error in retrieving the message
- */
-async function getMessage({ user, messageId }) {
- try {
- return await Message.findOne({
- user,
- messageId,
- }).lean();
- } catch (err) {
- logger.error('Error getting message:', err);
- throw err;
- }
-}
-
-/**
- * Deletes messages from the database.
- *
- * @async
- * @function deleteMessages
- * @param {import('mongoose').FilterQuery<import('mongoose').Document>} filter - The filter criteria to find messages to delete.
- * @returns {Promise<import('mongoose').DeleteResult>} The metadata with count of deleted messages.
- * @throws {Error} If there is an error in deleting messages.
- */
-async function deleteMessages(filter) {
- try {
- return await Message.deleteMany(filter);
- } catch (err) {
- logger.error('Error deleting messages:', err);
- throw err;
- }
-}
-
-module.exports = {
- saveMessage,
- bulkSaveMessages,
- recordMessage,
- updateMessageText,
- updateMessage,
- deleteMessagesSince,
- getMessages,
- getMessage,
- deleteMessages,
-};
diff --git a/api/models/Preset.js b/api/models/Preset.js
deleted file mode 100644
index 4db3d59066..0000000000
--- a/api/models/Preset.js
+++ /dev/null
@@ -1,82 +0,0 @@
-const { logger } = require('@librechat/data-schemas');
-const { Preset } = require('~/db/models');
-
-const getPreset = async (user, presetId) => {
- try {
- return await Preset.findOne({ user, presetId }).lean();
- } catch (error) {
- logger.error('[getPreset] Error getting single preset', error);
- return { message: 'Error getting single preset' };
- }
-};
-
-module.exports = {
- getPreset,
- getPresets: async (user, filter) => {
- try {
- const presets = await Preset.find({ ...filter, user }).lean();
- const defaultValue = 10000;
-
- presets.sort((a, b) => {
- let orderA = a.order !== undefined ? a.order : defaultValue;
- let orderB = b.order !== undefined ? b.order : defaultValue;
-
- if (orderA !== orderB) {
- return orderA - orderB;
- }
-
- return b.updatedAt - a.updatedAt;
- });
-
- return presets;
- } catch (error) {
- logger.error('[getPresets] Error getting presets', error);
- return { message: 'Error retrieving presets' };
- }
- },
- savePreset: async (user, { presetId, newPresetId, defaultPreset, ...preset }) => {
- try {
- const setter = { $set: {} };
- const { user: _, ...cleanPreset } = preset;
- const update = { presetId, ...cleanPreset };
- if (preset.tools && Array.isArray(preset.tools)) {
- update.tools =
- preset.tools
- .map((tool) => tool?.pluginKey ?? tool)
- .filter((toolName) => typeof toolName === 'string') ?? [];
- }
- if (newPresetId) {
- update.presetId = newPresetId;
- }
-
- if (defaultPreset) {
- update.defaultPreset = defaultPreset;
- update.order = 0;
-
- const currentDefault = await Preset.findOne({ defaultPreset: true, user });
-
- if (currentDefault && currentDefault.presetId !== presetId) {
- await Preset.findByIdAndUpdate(currentDefault._id, {
- $unset: { defaultPreset: '', order: '' },
- });
- }
- } else if (defaultPreset === false) {
- update.defaultPreset = undefined;
- update.order = undefined;
- setter['$unset'] = { defaultPreset: '', order: '' };
- }
-
- setter.$set = update;
- return await Preset.findOneAndUpdate({ presetId, user }, setter, { new: true, upsert: true });
- } catch (error) {
- logger.error('[savePreset] Error saving preset', error);
- return { message: 'Error saving preset' };
- }
- },
- deletePresets: async (user, filter) => {
- // let toRemove = await Preset.find({ ...filter, user }).select('presetId');
- // const ids = toRemove.map((instance) => instance.presetId);
- let deleteCount = await Preset.deleteMany({ ...filter, user });
- return deleteCount;
- },
-};
diff --git a/api/models/Prompt.js b/api/models/Prompt.js
deleted file mode 100644
index 38d56b53a4..0000000000
--- a/api/models/Prompt.js
+++ /dev/null
@@ -1,588 +0,0 @@
-const { ObjectId } = require('mongodb');
-const { escapeRegExp } = require('@librechat/api');
-const { logger } = require('@librechat/data-schemas');
-const { SystemRoles, ResourceType, SystemCategories } = require('librechat-data-provider');
-const {
- getSoleOwnedResourceIds,
- removeAllPermissions,
-} = require('~/server/services/PermissionService');
-const { PromptGroup, Prompt, AclEntry } = require('~/db/models');
-
-/**
- * Batch-fetches production prompts for an array of prompt groups
- * and attaches them as `productionPrompt` field.
- * Replaces $lookup aggregation for FerretDB compatibility.
- */
-const attachProductionPrompts = async (groups) => {
- const uniqueIds = [...new Set(groups.map((g) => g.productionId?.toString()).filter(Boolean))];
- if (uniqueIds.length === 0) {
- return groups.map((g) => ({ ...g, productionPrompt: null }));
- }
-
- const prompts = await Prompt.find({ _id: { $in: uniqueIds } })
- .select('prompt')
- .lean();
- const promptMap = new Map(prompts.map((p) => [p._id.toString(), p]));
-
- return groups.map((g) => ({
- ...g,
- productionPrompt: g.productionId ? (promptMap.get(g.productionId.toString()) ?? null) : null,
- }));
-};
-
-/**
- * Get all prompt groups with filters
- * @param {ServerRequest} req
- * @param {TPromptGroupsWithFilterRequest} filter
- * @returns {Promise<PromptGroupListResponse>}
- */
-const getAllPromptGroups = async (req, filter) => {
- try {
- const { name, ...query } = filter;
-
- if (name) {
- query.name = new RegExp(escapeRegExp(name), 'i');
- }
- if (!query.category) {
- delete query.category;
- } else if (query.category === SystemCategories.MY_PROMPTS) {
- delete query.category;
- } else if (query.category === SystemCategories.NO_CATEGORY) {
- query.category = '';
- } else if (query.category === SystemCategories.SHARED_PROMPTS) {
- delete query.category;
- }
-
- let combinedQuery = query;
-
- const groups = await PromptGroup.find(combinedQuery)
- .sort({ createdAt: -1 })
- .select('name oneliner category author authorName createdAt updatedAt command productionId')
- .lean();
- return await attachProductionPrompts(groups);
- } catch (error) {
- console.error('Error getting all prompt groups', error);
- return { message: 'Error getting all prompt groups' };
- }
-};
-
-/**
- * Get prompt groups with filters
- * @param {ServerRequest} req
- * @param {TPromptGroupsWithFilterRequest} filter
- * @returns {Promise<PromptGroupListResponse>}
- */
-const getPromptGroups = async (req, filter) => {
- try {
- const { pageNumber = 1, pageSize = 10, name, ...query } = filter;
-
- const validatedPageNumber = Math.max(parseInt(pageNumber, 10), 1);
- const validatedPageSize = Math.max(parseInt(pageSize, 10), 1);
-
- if (name) {
- query.name = new RegExp(escapeRegExp(name), 'i');
- }
- if (!query.category) {
- delete query.category;
- } else if (query.category === SystemCategories.MY_PROMPTS) {
- delete query.category;
- } else if (query.category === SystemCategories.NO_CATEGORY) {
- query.category = '';
- } else if (query.category === SystemCategories.SHARED_PROMPTS) {
- delete query.category;
- }
-
- let combinedQuery = query;
-
- const skip = (validatedPageNumber - 1) * validatedPageSize;
- const limit = validatedPageSize;
-
- const [groups, totalPromptGroups] = await Promise.all([
- PromptGroup.find(combinedQuery)
- .sort({ createdAt: -1 })
- .skip(skip)
- .limit(limit)
- .select(
- 'name numberOfGenerations oneliner category productionId author authorName createdAt updatedAt',
- )
- .lean(),
- PromptGroup.countDocuments(combinedQuery),
- ]);
-
- const promptGroups = await attachProductionPrompts(groups);
-
- return {
- promptGroups,
- pageNumber: validatedPageNumber.toString(),
- pageSize: validatedPageSize.toString(),
- pages: Math.ceil(totalPromptGroups / validatedPageSize).toString(),
- };
- } catch (error) {
- console.error('Error getting prompt groups', error);
- return { message: 'Error getting prompt groups' };
- }
-};
-
-/**
- * @param {Object} fields
- * @param {string} fields._id
- * @param {string} fields.author
- * @param {string} fields.role
- * @returns {Promise<TDeletePromptGroupResponse>}
- */
-const deletePromptGroup = async ({ _id, author, role }) => {
- // Build query - with ACL, author is optional
- const query = { _id };
- const groupQuery = { groupId: new ObjectId(_id) };
-
- // Legacy: Add author filter if provided (backward compatibility)
- if (author && role !== SystemRoles.ADMIN) {
- query.author = author;
- groupQuery.author = author;
- }
-
- const response = await PromptGroup.deleteOne(query);
-
- if (!response || response.deletedCount === 0) {
- throw new Error('Prompt group not found');
- }
-
- await Prompt.deleteMany(groupQuery);
-
- try {
- await removeAllPermissions({ resourceType: ResourceType.PROMPTGROUP, resourceId: _id });
- } catch (error) {
- logger.error('Error removing promptGroup permissions:', error);
- }
-
- return { message: 'Prompt group deleted successfully' };
-};
-
-/**
- * Get prompt groups by accessible IDs with optional cursor-based pagination.
- * @param {Object} params - The parameters for getting accessible prompt groups.
- * @param {Array} [params.accessibleIds] - Array of prompt group ObjectIds the user has ACL access to.
- * @param {Object} [params.otherParams] - Additional query parameters (including author filter).
- * @param {number} [params.limit] - Number of prompt groups to return (max 100). If not provided, returns all prompt groups.
- * @param {string} [params.after] - Cursor for pagination - get prompt groups after this cursor. // base64 encoded JSON string with updatedAt and _id.
- * @returns {Promise<Object>} A promise that resolves to an object containing the prompt groups data and pagination info.
- */
-async function getListPromptGroupsByAccess({
- accessibleIds = [],
- otherParams = {},
- limit = null,
- after = null,
-}) {
- const isPaginated = limit !== null && limit !== undefined;
- const normalizedLimit = isPaginated ? Math.min(Math.max(1, parseInt(limit) || 20), 100) : null;
-
- const baseQuery = { ...otherParams, _id: { $in: accessibleIds } };
-
- if (after && typeof after === 'string' && after !== 'undefined' && after !== 'null') {
- try {
- const cursor = JSON.parse(Buffer.from(after, 'base64').toString('utf8'));
- const { updatedAt, _id } = cursor;
-
- const cursorCondition = {
- $or: [
- { updatedAt: { $lt: new Date(updatedAt) } },
- { updatedAt: new Date(updatedAt), _id: { $gt: new ObjectId(_id) } },
- ],
- };
-
- if (Object.keys(baseQuery).length > 0) {
- baseQuery.$and = [{ ...baseQuery }, cursorCondition];
- Object.keys(baseQuery).forEach((key) => {
- if (key !== '$and') delete baseQuery[key];
- });
- } else {
- Object.assign(baseQuery, cursorCondition);
- }
- } catch (error) {
- logger.warn('Invalid cursor:', error.message);
- }
- }
-
- const findQuery = PromptGroup.find(baseQuery)
- .sort({ updatedAt: -1, _id: 1 })
- .select(
- 'name numberOfGenerations oneliner category productionId author authorName createdAt updatedAt',
- );
-
- if (isPaginated) {
- findQuery.limit(normalizedLimit + 1);
- }
-
- const groups = await findQuery.lean();
- const promptGroups = await attachProductionPrompts(groups);
-
- const hasMore = isPaginated ? promptGroups.length > normalizedLimit : false;
- const data = (isPaginated ? promptGroups.slice(0, normalizedLimit) : promptGroups).map(
- (group) => {
- if (group.author) {
- group.author = group.author.toString();
- }
- return group;
- },
- );
-
- let nextCursor = null;
- if (isPaginated && hasMore && data.length > 0) {
- const lastGroup = promptGroups[normalizedLimit - 1];
- nextCursor = Buffer.from(
- JSON.stringify({
- updatedAt: lastGroup.updatedAt.toISOString(),
- _id: lastGroup._id.toString(),
- }),
- ).toString('base64');
- }
-
- return {
- object: 'list',
- data,
- first_id: data.length > 0 ? data[0]._id.toString() : null,
- last_id: data.length > 0 ? data[data.length - 1]._id.toString() : null,
- has_more: hasMore,
- after: nextCursor,
- };
-}
-
-module.exports = {
- getPromptGroups,
- deletePromptGroup,
- getAllPromptGroups,
- getListPromptGroupsByAccess,
- /**
- * Create a prompt and its respective group
- * @param {TCreatePromptRecord} saveData
- * @returns {Promise<TCreatePromptResponse>}
- */
- createPromptGroup: async (saveData) => {
- try {
- const { prompt, group, author, authorName } = saveData;
-
- let newPromptGroup = await PromptGroup.findOneAndUpdate(
- { ...group, author, authorName, productionId: null },
- { $setOnInsert: { ...group, author, authorName, productionId: null } },
- { new: true, upsert: true },
- )
- .lean()
- .select('-__v')
- .exec();
-
- const newPrompt = await Prompt.findOneAndUpdate(
- { ...prompt, author, groupId: newPromptGroup._id },
- { $setOnInsert: { ...prompt, author, groupId: newPromptGroup._id } },
- { new: true, upsert: true },
- )
- .lean()
- .select('-__v')
- .exec();
-
- newPromptGroup = await PromptGroup.findByIdAndUpdate(
- newPromptGroup._id,
- { productionId: newPrompt._id },
- { new: true },
- )
- .lean()
- .select('-__v')
- .exec();
-
- return {
- prompt: newPrompt,
- group: {
- ...newPromptGroup,
- productionPrompt: { prompt: newPrompt.prompt },
- },
- };
- } catch (error) {
- logger.error('Error saving prompt group', error);
- throw new Error('Error saving prompt group');
- }
- },
- /**
- * Save a prompt
- * @param {TCreatePromptRecord} saveData
- * @returns {Promise<TCreatePromptResponse>}
- */
- savePrompt: async (saveData) => {
- try {
- const { prompt, author } = saveData;
- const newPromptData = {
- ...prompt,
- author,
- };
-
- /** @type {TPrompt} */
- let newPrompt;
- try {
- newPrompt = await Prompt.create(newPromptData);
- } catch (error) {
- if (error?.message?.includes('groupId_1_version_1')) {
- await Prompt.db.collection('prompts').dropIndex('groupId_1_version_1');
- } else {
- throw error;
- }
- newPrompt = await Prompt.create(newPromptData);
- }
-
- return { prompt: newPrompt };
- } catch (error) {
- logger.error('Error saving prompt', error);
- return { message: 'Error saving prompt' };
- }
- },
- getPrompts: async (filter) => {
- try {
- return await Prompt.find(filter).sort({ createdAt: -1 }).lean();
- } catch (error) {
- logger.error('Error getting prompts', error);
- return { message: 'Error getting prompts' };
- }
- },
- getPrompt: async (filter) => {
- try {
- if (filter.groupId) {
- filter.groupId = new ObjectId(filter.groupId);
- }
- return await Prompt.findOne(filter).lean();
- } catch (error) {
- logger.error('Error getting prompt', error);
- return { message: 'Error getting prompt' };
- }
- },
- /**
- * Get prompt groups with filters
- * @param {TGetRandomPromptsRequest} filter
- * @returns {Promise<TGetRandomPromptsResponse>}
- */
- getRandomPromptGroups: async (filter) => {
- try {
- const categories = await PromptGroup.distinct('category', { category: { $ne: '' } });
-
- for (let i = categories.length - 1; i > 0; i--) {
- const j = Math.floor(Math.random() * (i + 1));
- [categories[i], categories[j]] = [categories[j], categories[i]];
- }
-
- const skip = +filter.skip;
- const limit = +filter.limit;
- const selectedCategories = categories.slice(skip, skip + limit);
-
- if (selectedCategories.length === 0) {
- return { prompts: [] };
- }
-
- const groups = await PromptGroup.find({ category: { $in: selectedCategories } }).lean();
-
- const groupByCategory = new Map();
- for (const group of groups) {
- if (!groupByCategory.has(group.category)) {
- groupByCategory.set(group.category, group);
- }
- }
-
- const prompts = selectedCategories.map((cat) => groupByCategory.get(cat)).filter(Boolean);
-
- return { prompts };
- } catch (error) {
- logger.error('Error getting prompt groups', error);
- return { message: 'Error getting prompt groups' };
- }
- },
- getPromptGroupsWithPrompts: async (filter) => {
- try {
- return await PromptGroup.findOne(filter)
- .populate({
- path: 'prompts',
- select: '-_id -__v -user',
- })
- .select('-_id -__v -user')
- .lean();
- } catch (error) {
- logger.error('Error getting prompt groups', error);
- return { message: 'Error getting prompt groups' };
- }
- },
- getPromptGroup: async (filter) => {
- try {
- return await PromptGroup.findOne(filter).lean();
- } catch (error) {
- logger.error('Error getting prompt group', error);
- return { message: 'Error getting prompt group' };
- }
- },
- /**
- * Deletes a prompt and its corresponding prompt group if it is the last prompt in the group.
- *
- * @param {Object} options - The options for deleting the prompt.
- * @param {ObjectId|string} options.promptId - The ID of the prompt to delete.
- * @param {ObjectId|string} options.groupId - The ID of the prompt's group.
- * @param {ObjectId|string} options.author - The ID of the prompt's author.
- * @param {string} options.role - The role of the prompt's author.
- * @return {Promise<TDeletePromptResponse>} An object containing the result of the deletion.
- * If the prompt was deleted successfully, the object will have a property 'prompt' with the value 'Prompt deleted successfully'.
- * If the prompt group was deleted successfully, the object will have a property 'promptGroup' with the message 'Prompt group deleted successfully' and id of the deleted group.
- * If there was an error deleting the prompt, the object will have a property 'message' with the value 'Error deleting prompt'.
- */
- deletePrompt: async ({ promptId, groupId, author, role }) => {
- const query = { _id: promptId, groupId, author };
- if (role === SystemRoles.ADMIN) {
- delete query.author;
- }
- const { deletedCount } = await Prompt.deleteOne(query);
- if (deletedCount === 0) {
- throw new Error('Failed to delete the prompt');
- }
-
- const remainingPrompts = await Prompt.find({ groupId })
- .select('_id')
- .sort({ createdAt: 1 })
- .lean();
-
- if (remainingPrompts.length === 0) {
- // Remove all ACL entries for the promptGroup when deleting the last prompt
- try {
- await removeAllPermissions({
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: groupId,
- });
- } catch (error) {
- logger.error('Error removing promptGroup permissions:', error);
- }
-
- await PromptGroup.deleteOne({ _id: groupId });
-
- return {
- prompt: 'Prompt deleted successfully',
- promptGroup: {
- message: 'Prompt group deleted successfully',
- id: groupId,
- },
- };
- } else {
- const promptGroup = await PromptGroup.findById(groupId).lean();
- if (promptGroup.productionId.toString() === promptId.toString()) {
- await PromptGroup.updateOne(
- { _id: groupId },
- { productionId: remainingPrompts[remainingPrompts.length - 1]._id },
- );
- }
-
- return { prompt: 'Prompt deleted successfully' };
- }
- },
- /**
- * Delete prompt groups solely owned by the user and clean up their prompts/ACLs.
- * Groups with other owners are left intact; the caller is responsible for
- * removing the user's own ACL principal entries separately.
- *
- * Also handles legacy (pre-ACL) prompt groups that only have the author field set,
- * ensuring they are not orphaned if the permission migration has not been run.
- * @param {string} userId - The ID of the user whose prompts and prompt groups are to be deleted.
- */
- deleteUserPrompts: async (userId) => {
- try {
- const userObjectId = new ObjectId(userId);
- const soleOwnedIds = await getSoleOwnedResourceIds(userObjectId, ResourceType.PROMPTGROUP);
-
- const authoredGroups = await PromptGroup.find({ author: userObjectId }).select('_id').lean();
- const authoredGroupIds = authoredGroups.map((g) => g._id);
-
- const migratedEntries =
- authoredGroupIds.length > 0
- ? await AclEntry.find({
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: { $in: authoredGroupIds },
- })
- .select('resourceId')
- .lean()
- : [];
- const migratedIds = new Set(migratedEntries.map((e) => e.resourceId.toString()));
- const legacyGroupIds = authoredGroupIds.filter((id) => !migratedIds.has(id.toString()));
-
- const allGroupIdsToDelete = [...soleOwnedIds, ...legacyGroupIds];
-
- if (allGroupIdsToDelete.length === 0) {
- return;
- }
-
- await AclEntry.deleteMany({
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: { $in: allGroupIdsToDelete },
- });
-
- await PromptGroup.deleteMany({ _id: { $in: allGroupIdsToDelete } });
- await Prompt.deleteMany({ groupId: { $in: allGroupIdsToDelete } });
- } catch (error) {
- logger.error('[deleteUserPrompts] General error:', error);
- }
- },
- /**
- * Update prompt group
- * @param {Partial<MongoPromptGroup>} filter - Filter to find prompt group
- * @param {Partial<MongoPromptGroup>} data - Data to update
- * @returns {Promise<TUpdatePromptGroupResponse>}
- */
- updatePromptGroup: async (filter, data) => {
- try {
- const updateOps = {};
-
- const updateData = { ...data, ...updateOps };
- const updatedDoc = await PromptGroup.findOneAndUpdate(filter, updateData, {
- new: true,
- upsert: false,
- });
-
- if (!updatedDoc) {
- throw new Error('Prompt group not found');
- }
-
- return updatedDoc;
- } catch (error) {
- logger.error('Error updating prompt group', error);
- return { message: 'Error updating prompt group' };
- }
- },
- /**
- * Function to make a prompt production based on its ID.
- * @param {String} promptId - The ID of the prompt to make production.
- * @returns {Object} The result of the production operation.
- */
- makePromptProduction: async (promptId) => {
- try {
- const prompt = await Prompt.findById(promptId).lean();
-
- if (!prompt) {
- throw new Error('Prompt not found');
- }
-
- await PromptGroup.findByIdAndUpdate(
- prompt.groupId,
- { productionId: prompt._id },
- { new: true },
- )
- .lean()
- .exec();
-
- return {
- message: 'Prompt production made successfully',
- };
- } catch (error) {
- logger.error('Error making prompt production', error);
- return { message: 'Error making prompt production' };
- }
- },
- updatePromptLabels: async (_id, labels) => {
- try {
- const response = await Prompt.updateOne({ _id }, { $set: { labels } });
- if (response.matchedCount === 0) {
- return { message: 'Prompt not found' };
- }
- return { message: 'Prompt labels updated successfully' };
- } catch (error) {
- logger.error('Error updating prompt labels', error);
- return { message: 'Error updating prompt labels' };
- }
- },
-};
diff --git a/api/models/Prompt.spec.js b/api/models/Prompt.spec.js
deleted file mode 100644
index 5c1c8c8256..0000000000
--- a/api/models/Prompt.spec.js
+++ /dev/null
@@ -1,784 +0,0 @@
-const mongoose = require('mongoose');
-const { ObjectId } = require('mongodb');
-const { logger } = require('@librechat/data-schemas');
-const { MongoMemoryServer } = require('mongodb-memory-server');
-const {
- SystemRoles,
- ResourceType,
- AccessRoleIds,
- PrincipalType,
- PermissionBits,
-} = require('librechat-data-provider');
-
-// Mock the config/connect module to prevent connection attempts during tests
-jest.mock('../../config/connect', () => jest.fn().mockResolvedValue(true));
-
-const dbModels = require('~/db/models');
-
-// Disable console for tests
-logger.silent = true;
-
-let mongoServer;
-let Prompt, PromptGroup, AclEntry, AccessRole, User, Group;
-let promptFns, permissionService;
-let testUsers, testGroups, testRoles;
-
-beforeAll(async () => {
- // Set up MongoDB memory server
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- await mongoose.connect(mongoUri);
-
- // Initialize models
- Prompt = dbModels.Prompt;
- PromptGroup = dbModels.PromptGroup;
- AclEntry = dbModels.AclEntry;
- AccessRole = dbModels.AccessRole;
- User = dbModels.User;
- Group = dbModels.Group;
-
- promptFns = require('~/models/Prompt');
- permissionService = require('~/server/services/PermissionService');
-
- // Create test data
- await setupTestData();
-});
-
-afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- jest.clearAllMocks();
-});
-
-async function setupTestData() {
- // Create access roles for promptGroups
- testRoles = {
- viewer: await AccessRole.create({
- accessRoleId: AccessRoleIds.PROMPTGROUP_VIEWER,
- name: 'Viewer',
- description: 'Can view promptGroups',
- resourceType: ResourceType.PROMPTGROUP,
- permBits: PermissionBits.VIEW,
- }),
- editor: await AccessRole.create({
- accessRoleId: AccessRoleIds.PROMPTGROUP_EDITOR,
- name: 'Editor',
- description: 'Can view and edit promptGroups',
- resourceType: ResourceType.PROMPTGROUP,
- permBits: PermissionBits.VIEW | PermissionBits.EDIT,
- }),
- owner: await AccessRole.create({
- accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
- name: 'Owner',
- description: 'Full control over promptGroups',
- resourceType: ResourceType.PROMPTGROUP,
- permBits:
- PermissionBits.VIEW | PermissionBits.EDIT | PermissionBits.DELETE | PermissionBits.SHARE,
- }),
- };
-
- // Create test users
- testUsers = {
- owner: await User.create({
- name: 'Prompt Owner',
- email: '[email protected]',
- role: SystemRoles.USER,
- }),
- editor: await User.create({
- name: 'Prompt Editor',
- email: '[email protected]',
- role: SystemRoles.USER,
- }),
- viewer: await User.create({
- name: 'Prompt Viewer',
- email: '[email protected]',
- role: SystemRoles.USER,
- }),
- admin: await User.create({
- name: 'Admin User',
- email: '[email protected]',
- role: SystemRoles.ADMIN,
- }),
- noAccess: await User.create({
- name: 'No Access User',
- email: '[email protected]',
- role: SystemRoles.USER,
- }),
- };
-
- // Create test groups
- testGroups = {
- editors: await Group.create({
- name: 'Prompt Editors',
- description: 'Group with editor access',
- }),
- viewers: await Group.create({
- name: 'Prompt Viewers',
- description: 'Group with viewer access',
- }),
- };
-}
-
-describe('Prompt ACL Permissions', () => {
- describe('Creating Prompts with Permissions', () => {
- it('should grant owner permissions when creating a prompt', async () => {
- // First create a group
- const testGroup = await PromptGroup.create({
- name: 'Test Group',
- category: 'testing',
- author: testUsers.owner._id,
- authorName: testUsers.owner.name,
- productionId: new mongoose.Types.ObjectId(),
- });
-
- const promptData = {
- prompt: {
- prompt: 'Test prompt content',
- name: 'Test Prompt',
- type: 'text',
- groupId: testGroup._id,
- },
- author: testUsers.owner._id,
- };
-
- await promptFns.savePrompt(promptData);
-
- // Manually grant permissions as would happen in the route
- await permissionService.grantPermission({
- principalType: PrincipalType.USER,
- principalId: testUsers.owner._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
- grantedBy: testUsers.owner._id,
- });
-
- // Check ACL entry
- const aclEntry = await AclEntry.findOne({
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testGroup._id,
- principalType: PrincipalType.USER,
- principalId: testUsers.owner._id,
- });
-
- expect(aclEntry).toBeTruthy();
- expect(aclEntry.permBits).toBe(testRoles.owner.permBits);
- });
- });
-
- describe('Accessing Prompts', () => {
- let testPromptGroup;
-
- beforeEach(async () => {
- // Create a prompt group
- testPromptGroup = await PromptGroup.create({
- name: 'Test Group',
- author: testUsers.owner._id,
- authorName: testUsers.owner.name,
- productionId: new ObjectId(),
- });
-
- // Create a prompt
- await Prompt.create({
- prompt: 'Test prompt for access control',
- name: 'Access Test Prompt',
- author: testUsers.owner._id,
- groupId: testPromptGroup._id,
- type: 'text',
- });
-
- // Grant owner permissions
- await permissionService.grantPermission({
- principalType: PrincipalType.USER,
- principalId: testUsers.owner._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
- grantedBy: testUsers.owner._id,
- });
- });
-
- afterEach(async () => {
- await Prompt.deleteMany({});
- await PromptGroup.deleteMany({});
- await AclEntry.deleteMany({});
- });
-
- it('owner should have full access to their prompt', async () => {
- const hasAccess = await permissionService.checkPermission({
- userId: testUsers.owner._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- requiredPermission: PermissionBits.VIEW,
- });
-
- expect(hasAccess).toBe(true);
-
- const canEdit = await permissionService.checkPermission({
- userId: testUsers.owner._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- requiredPermission: PermissionBits.EDIT,
- });
-
- expect(canEdit).toBe(true);
- });
-
- it('user with viewer role should only have view access', async () => {
- // Grant viewer permissions
- await permissionService.grantPermission({
- principalType: PrincipalType.USER,
- principalId: testUsers.viewer._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_VIEWER,
- grantedBy: testUsers.owner._id,
- });
-
- const canView = await permissionService.checkPermission({
- userId: testUsers.viewer._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- requiredPermission: PermissionBits.VIEW,
- });
-
- const canEdit = await permissionService.checkPermission({
- userId: testUsers.viewer._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- requiredPermission: PermissionBits.EDIT,
- });
-
- expect(canView).toBe(true);
- expect(canEdit).toBe(false);
- });
-
- it('user without permissions should have no access', async () => {
- const hasAccess = await permissionService.checkPermission({
- userId: testUsers.noAccess._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- requiredPermission: PermissionBits.VIEW,
- });
-
- expect(hasAccess).toBe(false);
- });
-
- it('admin should have access regardless of permissions', async () => {
- // Admin users should work through normal permission system
- // The middleware layer handles admin bypass, not the permission service
- const hasAccess = await permissionService.checkPermission({
- userId: testUsers.admin._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- requiredPermission: PermissionBits.VIEW,
- });
-
- // Without explicit permissions, even admin won't have access at this layer
- expect(hasAccess).toBe(false);
-
- // The actual admin bypass happens in the middleware layer (`canAccessPromptViaGroup`/`canAccessPromptGroupResource`)
- // which checks req.user.role === SystemRoles.ADMIN
- });
- });
-
- describe('Group-based Access', () => {
- let testPromptGroup;
-
- beforeEach(async () => {
- // Create a prompt group first
- testPromptGroup = await PromptGroup.create({
- name: 'Group Access Test Group',
- author: testUsers.owner._id,
- authorName: testUsers.owner.name,
- productionId: new ObjectId(),
- });
-
- await Prompt.create({
- prompt: 'Group access test prompt',
- name: 'Group Test',
- author: testUsers.owner._id,
- groupId: testPromptGroup._id,
- type: 'text',
- });
-
- // Add users to groups
- await User.findByIdAndUpdate(testUsers.editor._id, {
- $push: { groups: testGroups.editors._id },
- });
-
- await User.findByIdAndUpdate(testUsers.viewer._id, {
- $push: { groups: testGroups.viewers._id },
- });
- });
-
- afterEach(async () => {
- await Prompt.deleteMany({});
- await AclEntry.deleteMany({});
- await User.updateMany({}, { $set: { groups: [] } });
- });
-
- it('group members should inherit group permissions', async () => {
- // Create a prompt group
- const testPromptGroup = await PromptGroup.create({
- name: 'Group Test Group',
- author: testUsers.owner._id,
- authorName: testUsers.owner.name,
- productionId: new ObjectId(),
- });
-
- const { addUserToGroup } = require('~/models');
- await addUserToGroup(testUsers.editor._id, testGroups.editors._id);
-
- const prompt = await promptFns.savePrompt({
- author: testUsers.owner._id,
- prompt: {
- prompt: 'Group test prompt',
- name: 'Group Test',
- groupId: testPromptGroup._id,
- type: 'text',
- },
- });
-
- // Check if savePrompt returned an error
- if (!prompt || !prompt.prompt) {
- throw new Error(`Failed to save prompt: ${prompt?.message || 'Unknown error'}`);
- }
-
- // Grant edit permissions to the group
- await permissionService.grantPermission({
- principalType: PrincipalType.GROUP,
- principalId: testGroups.editors._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_EDITOR,
- grantedBy: testUsers.owner._id,
- });
-
- // Check if group member has access
- const hasAccess = await permissionService.checkPermission({
- userId: testUsers.editor._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- requiredPermission: PermissionBits.EDIT,
- });
-
- expect(hasAccess).toBe(true);
-
- // Check that non-member doesn't have access
- const nonMemberAccess = await permissionService.checkPermission({
- userId: testUsers.viewer._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- requiredPermission: PermissionBits.EDIT,
- });
-
- expect(nonMemberAccess).toBe(false);
- });
- });
-
- describe('Public Access', () => {
- let publicPromptGroup, privatePromptGroup;
-
- beforeEach(async () => {
- // Create separate prompt groups for public and private access
- publicPromptGroup = await PromptGroup.create({
- name: 'Public Access Test Group',
- author: testUsers.owner._id,
- authorName: testUsers.owner.name,
- productionId: new ObjectId(),
- });
-
- privatePromptGroup = await PromptGroup.create({
- name: 'Private Access Test Group',
- author: testUsers.owner._id,
- authorName: testUsers.owner.name,
- productionId: new ObjectId(),
- });
-
- // Create prompts in their respective groups
- await Prompt.create({
- prompt: 'Public prompt',
- name: 'Public',
- author: testUsers.owner._id,
- groupId: publicPromptGroup._id,
- type: 'text',
- });
-
- await Prompt.create({
- prompt: 'Private prompt',
- name: 'Private',
- author: testUsers.owner._id,
- groupId: privatePromptGroup._id,
- type: 'text',
- });
-
- // Grant public view access to publicPromptGroup
- await permissionService.grantPermission({
- principalType: PrincipalType.PUBLIC,
- principalId: null,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: publicPromptGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_VIEWER,
- grantedBy: testUsers.owner._id,
- });
-
- // Grant only owner access to privatePromptGroup
- await permissionService.grantPermission({
- principalType: PrincipalType.USER,
- principalId: testUsers.owner._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: privatePromptGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
- grantedBy: testUsers.owner._id,
- });
- });
-
- afterEach(async () => {
- await Prompt.deleteMany({});
- await PromptGroup.deleteMany({});
- await AclEntry.deleteMany({});
- });
-
- it('public prompt should be accessible to any user', async () => {
- const hasAccess = await permissionService.checkPermission({
- userId: testUsers.noAccess._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: publicPromptGroup._id,
- requiredPermission: PermissionBits.VIEW,
- includePublic: true,
- });
-
- expect(hasAccess).toBe(true);
- });
-
- it('private prompt should not be accessible to unauthorized users', async () => {
- const hasAccess = await permissionService.checkPermission({
- userId: testUsers.noAccess._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: privatePromptGroup._id,
- requiredPermission: PermissionBits.VIEW,
- includePublic: true,
- });
-
- expect(hasAccess).toBe(false);
- });
- });
-
- describe('Prompt Deletion', () => {
- let testPromptGroup;
-
- it('should remove ACL entries when prompt is deleted', async () => {
- testPromptGroup = await PromptGroup.create({
- name: 'Deletion Test Group',
- author: testUsers.owner._id,
- authorName: testUsers.owner.name,
- productionId: new ObjectId(),
- });
-
- const prompt = await promptFns.savePrompt({
- author: testUsers.owner._id,
- prompt: {
- prompt: 'To be deleted',
- name: 'Delete Test',
- groupId: testPromptGroup._id,
- type: 'text',
- },
- });
-
- // Check if savePrompt returned an error
- if (!prompt || !prompt.prompt) {
- throw new Error(`Failed to save prompt: ${prompt?.message || 'Unknown error'}`);
- }
-
- const testPromptId = prompt.prompt._id;
- const promptGroupId = testPromptGroup._id;
-
- // Grant permission
- await permissionService.grantPermission({
- principalType: PrincipalType.USER,
- principalId: testUsers.owner._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
- grantedBy: testUsers.owner._id,
- });
-
- // Verify ACL entry exists
- const beforeDelete = await AclEntry.find({
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- });
- expect(beforeDelete).toHaveLength(1);
-
- // Delete the prompt
- await promptFns.deletePrompt({
- promptId: testPromptId,
- groupId: promptGroupId,
- author: testUsers.owner._id,
- role: SystemRoles.USER,
- });
-
- // Verify ACL entries are removed
- const aclEntries = await AclEntry.find({
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: testPromptGroup._id,
- });
-
- expect(aclEntries).toHaveLength(0);
- });
- });
-
- describe('Backwards Compatibility', () => {
- it('should handle prompts without ACL entries gracefully', async () => {
- // Create a prompt group first
- const promptGroup = await PromptGroup.create({
- name: 'Legacy Test Group',
- author: testUsers.owner._id,
- authorName: testUsers.owner.name,
- productionId: new ObjectId(),
- });
-
- // Create a prompt without ACL entries (legacy prompt)
- const legacyPrompt = await Prompt.create({
- prompt: 'Legacy prompt without ACL',
- name: 'Legacy',
- author: testUsers.owner._id,
- groupId: promptGroup._id,
- type: 'text',
- });
-
- // The system should handle this gracefully
- const prompt = await promptFns.getPrompt({ _id: legacyPrompt._id });
- expect(prompt).toBeTruthy();
- expect(prompt._id.toString()).toBe(legacyPrompt._id.toString());
- });
- });
-
- describe('deleteUserPrompts', () => {
- let deletingUser;
- let otherUser;
- let soleOwnedGroup;
- let multiOwnedGroup;
- let sharedGroup;
- let soleOwnedPrompt;
- let multiOwnedPrompt;
- let sharedPrompt;
-
- beforeAll(async () => {
- deletingUser = await User.create({
- name: 'Deleting User',
- email: '[email protected]',
- role: SystemRoles.USER,
- });
- otherUser = await User.create({
- name: 'Other User',
- email: '[email protected]',
- role: SystemRoles.USER,
- });
-
- const soleProductionId = new ObjectId();
- soleOwnedGroup = await PromptGroup.create({
- name: 'Sole Owned Group',
- author: deletingUser._id,
- authorName: deletingUser.name,
- productionId: soleProductionId,
- });
- soleOwnedPrompt = await Prompt.create({
- prompt: 'Sole owned prompt',
- author: deletingUser._id,
- groupId: soleOwnedGroup._id,
- type: 'text',
- });
- await PromptGroup.updateOne(
- { _id: soleOwnedGroup._id },
- { productionId: soleOwnedPrompt._id },
- );
-
- const multiProductionId = new ObjectId();
- multiOwnedGroup = await PromptGroup.create({
- name: 'Multi Owned Group',
- author: deletingUser._id,
- authorName: deletingUser.name,
- productionId: multiProductionId,
- });
- multiOwnedPrompt = await Prompt.create({
- prompt: 'Multi owned prompt',
- author: deletingUser._id,
- groupId: multiOwnedGroup._id,
- type: 'text',
- });
- await PromptGroup.updateOne(
- { _id: multiOwnedGroup._id },
- { productionId: multiOwnedPrompt._id },
- );
-
- const sharedProductionId = new ObjectId();
- sharedGroup = await PromptGroup.create({
- name: 'Shared Group (other user owns)',
- author: otherUser._id,
- authorName: otherUser.name,
- productionId: sharedProductionId,
- });
- sharedPrompt = await Prompt.create({
- prompt: 'Shared prompt',
- author: otherUser._id,
- groupId: sharedGroup._id,
- type: 'text',
- });
- await PromptGroup.updateOne({ _id: sharedGroup._id }, { productionId: sharedPrompt._id });
-
- await permissionService.grantPermission({
- principalType: PrincipalType.USER,
- principalId: deletingUser._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: soleOwnedGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
- grantedBy: deletingUser._id,
- });
-
- await permissionService.grantPermission({
- principalType: PrincipalType.USER,
- principalId: deletingUser._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: multiOwnedGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
- grantedBy: deletingUser._id,
- });
- await permissionService.grantPermission({
- principalType: PrincipalType.USER,
- principalId: otherUser._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: multiOwnedGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
- grantedBy: otherUser._id,
- });
-
- await permissionService.grantPermission({
- principalType: PrincipalType.USER,
- principalId: otherUser._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: sharedGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
- grantedBy: otherUser._id,
- });
- await permissionService.grantPermission({
- principalType: PrincipalType.USER,
- principalId: deletingUser._id,
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: sharedGroup._id,
- accessRoleId: AccessRoleIds.PROMPTGROUP_VIEWER,
- grantedBy: otherUser._id,
- });
-
- const globalProject = await Project.findOne({ name: 'Global' });
- await Project.updateOne(
- { _id: globalProject._id },
- {
- $addToSet: {
- promptGroupIds: {
- $each: [soleOwnedGroup._id, multiOwnedGroup._id, sharedGroup._id],
- },
- },
- },
- );
-
- await promptFns.deleteUserPrompts(deletingUser._id.toString());
- });
-
- test('should delete solely-owned prompt groups and their prompts', async () => {
- expect(await PromptGroup.findById(soleOwnedGroup._id)).toBeNull();
- expect(await Prompt.findById(soleOwnedPrompt._id)).toBeNull();
- });
-
- test('should remove solely-owned groups from projects', async () => {
- const globalProject = await Project.findOne({ name: 'Global' });
- const projectGroupIds = globalProject.promptGroupIds.map((id) => id.toString());
- expect(projectGroupIds).not.toContain(soleOwnedGroup._id.toString());
- });
-
- test('should remove all ACL entries for solely-owned groups', async () => {
- const aclEntries = await AclEntry.find({
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: soleOwnedGroup._id,
- });
- expect(aclEntries).toHaveLength(0);
- });
-
- test('should preserve multi-owned prompt groups', async () => {
- expect(await PromptGroup.findById(multiOwnedGroup._id)).not.toBeNull();
- expect(await Prompt.findById(multiOwnedPrompt._id)).not.toBeNull();
- });
-
- test('should preserve ACL entries of other owners on multi-owned groups', async () => {
- const otherOwnerAcl = await AclEntry.findOne({
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: multiOwnedGroup._id,
- principalId: otherUser._id,
- });
- expect(otherOwnerAcl).not.toBeNull();
- expect(otherOwnerAcl.permBits & PermissionBits.DELETE).toBeTruthy();
- });
-
- test('should preserve groups owned by other users', async () => {
- expect(await PromptGroup.findById(sharedGroup._id)).not.toBeNull();
- expect(await Prompt.findById(sharedPrompt._id)).not.toBeNull();
- });
-
- test('should preserve project membership of non-deleted groups', async () => {
- const globalProject = await Project.findOne({ name: 'Global' });
- const projectGroupIds = globalProject.promptGroupIds.map((id) => id.toString());
- expect(projectGroupIds).toContain(multiOwnedGroup._id.toString());
- expect(projectGroupIds).toContain(sharedGroup._id.toString());
- });
-
- test('should preserve ACL entries for shared group owned by other user', async () => {
- const ownerAcl = await AclEntry.findOne({
- resourceType: ResourceType.PROMPTGROUP,
- resourceId: sharedGroup._id,
- principalId: otherUser._id,
- });
- expect(ownerAcl).not.toBeNull();
- });
-
- test('should be a no-op when user has no owned prompt groups', async () => {
- const unrelatedUser = await User.create({
- name: 'Unrelated User',
- email: '[email protected]',
- role: SystemRoles.USER,
- });
-
- const beforeCount = await PromptGroup.countDocuments();
- await promptFns.deleteUserPrompts(unrelatedUser._id.toString());
- const afterCount = await PromptGroup.countDocuments();
-
- expect(afterCount).toBe(beforeCount);
- });
-
- test('should delete legacy prompt groups that have author but no ACL entries', async () => {
- const legacyUser = await User.create({
- name: 'Legacy User',
- email: '[email protected]',
- role: SystemRoles.USER,
- });
-
- const legacyGroup = await PromptGroup.create({
- name: 'Legacy Group (no ACL)',
- author: legacyUser._id,
- authorName: legacyUser.name,
- productionId: new ObjectId(),
- });
- const legacyPrompt = await Prompt.create({
- prompt: 'Legacy prompt text',
- author: legacyUser._id,
- groupId: legacyGroup._id,
- type: 'text',
- });
-
- await promptFns.deleteUserPrompts(legacyUser._id.toString());
-
- expect(await PromptGroup.findById(legacyGroup._id)).toBeNull();
- expect(await Prompt.findById(legacyPrompt._id)).toBeNull();
- });
- });
-});
diff --git a/api/models/Role.js b/api/models/Role.js
deleted file mode 100644
index b7f806f3b6..0000000000
--- a/api/models/Role.js
+++ /dev/null
@@ -1,304 +0,0 @@
-const {
- CacheKeys,
- SystemRoles,
- roleDefaults,
- permissionsSchema,
- removeNullishValues,
-} = require('librechat-data-provider');
-const { logger } = require('@librechat/data-schemas');
-const getLogStores = require('~/cache/getLogStores');
-const { Role } = require('~/db/models');
-
-/**
- * Retrieve a role by name and convert the found role document to a plain object.
- * If the role with the given name doesn't exist and the name is a system defined role,
- * create it and return the lean version.
- *
- * @param {string} roleName - The name of the role to find or create.
- * @param {string|string[]} [fieldsToSelect] - The fields to include or exclude in the returned document.
- * @returns {Promise<IRole>} Role document.
- */
-const getRoleByName = async function (roleName, fieldsToSelect = null) {
- const cache = getLogStores(CacheKeys.ROLES);
- try {
- const cachedRole = await cache.get(roleName);
- if (cachedRole) {
- return cachedRole;
- }
- let query = Role.findOne({ name: roleName });
- if (fieldsToSelect) {
- query = query.select(fieldsToSelect);
- }
- let role = await query.lean().exec();
-
- if (!role && SystemRoles[roleName]) {
- role = await new Role(roleDefaults[roleName]).save();
- await cache.set(roleName, role);
- return role.toObject();
- }
- await cache.set(roleName, role);
- return role;
- } catch (error) {
- throw new Error(`Failed to retrieve or create role: ${error.message}`);
- }
-};
-
-/**
- * Update role values by name.
- *
- * @param {string} roleName - The name of the role to update.
- * @param {Partial<TRole>} updates - The fields to update.
- * @returns {Promise<TRole>} Updated role document.
- */
-const updateRoleByName = async function (roleName, updates) {
- const cache = getLogStores(CacheKeys.ROLES);
- try {
- const role = await Role.findOneAndUpdate(
- { name: roleName },
- { $set: updates },
- { new: true, lean: true },
- )
- .select('-__v')
- .lean()
- .exec();
- await cache.set(roleName, role);
- return role;
- } catch (error) {
- throw new Error(`Failed to update role: ${error.message}`);
- }
-};
-
-/**
- * Updates access permissions for a specific role and multiple permission types.
- * @param {string} roleName - The role to update.
- * @param {Object.<PermissionTypes, Object.<Permissions, boolean>>} permissionsUpdate - Permissions to update and their values.
- * @param {IRole} [roleData] - Optional role data to use instead of fetching from the database.
- */
-async function updateAccessPermissions(roleName, permissionsUpdate, roleData) {
- // Filter and clean the permission updates based on our schema definition.
- const updates = {};
- for (const [permissionType, permissions] of Object.entries(permissionsUpdate)) {
- if (permissionsSchema.shape && permissionsSchema.shape[permissionType]) {
- updates[permissionType] = removeNullishValues(permissions);
- }
- }
- if (!Object.keys(updates).length) {
- return;
- }
-
- try {
- const role = roleData ?? (await getRoleByName(roleName));
- if (!role) {
- return;
- }
-
- const currentPermissions = role.permissions || {};
- const updatedPermissions = { ...currentPermissions };
- let hasChanges = false;
-
- const unsetFields = {};
- const permissionTypes = Object.keys(permissionsSchema.shape || {});
- for (const permType of permissionTypes) {
- if (role[permType] && typeof role[permType] === 'object') {
- logger.info(
- `Migrating '${roleName}' role from old schema: found '${permType}' at top level`,
- );
-
- updatedPermissions[permType] = {
- ...updatedPermissions[permType],
- ...role[permType],
- };
-
- unsetFields[permType] = 1;
- hasChanges = true;
- }
- }
-
- // Migrate legacy SHARED_GLOBAL → SHARE for PROMPTS and AGENTS.
- // SHARED_GLOBAL was removed in favour of SHARE in PR #11283. If the DB still has
- // SHARED_GLOBAL but not SHARE, inherit the value so sharing intent is preserved.
- const legacySharedGlobalTypes = ['PROMPTS', 'AGENTS'];
- for (const legacyPermType of legacySharedGlobalTypes) {
- const existingTypePerms = currentPermissions[legacyPermType];
- if (
- existingTypePerms &&
- 'SHARED_GLOBAL' in existingTypePerms &&
- !('SHARE' in existingTypePerms) &&
- updates[legacyPermType] &&
- // Don't override an explicit SHARE value the caller already provided
- !('SHARE' in updates[legacyPermType])
- ) {
- const inheritedValue = existingTypePerms['SHARED_GLOBAL'];
- updates[legacyPermType]['SHARE'] = inheritedValue;
- logger.info(
- `Migrating '${roleName}' role ${legacyPermType}.SHARED_GLOBAL=${inheritedValue} → SHARE`,
- );
- }
- }
-
- for (const [permissionType, permissions] of Object.entries(updates)) {
- const currentTypePermissions = currentPermissions[permissionType] || {};
- updatedPermissions[permissionType] = { ...currentTypePermissions };
-
- for (const [permission, value] of Object.entries(permissions)) {
- if (currentTypePermissions[permission] !== value) {
- updatedPermissions[permissionType][permission] = value;
- hasChanges = true;
- logger.info(
- `Updating '${roleName}' role permission '${permissionType}' '${permission}' from ${currentTypePermissions[permission]} to: ${value}`,
- );
- }
- }
- }
-
- // Clean up orphaned SHARED_GLOBAL fields left in DB after the schema rename.
- // Since we $set the full permissions object, deleting from updatedPermissions
- // is sufficient to remove the field from MongoDB.
- for (const legacyPermType of legacySharedGlobalTypes) {
- const existingTypePerms = currentPermissions[legacyPermType];
- if (existingTypePerms && 'SHARED_GLOBAL' in existingTypePerms) {
- if (!updates[legacyPermType]) {
- // permType wasn't in the update payload so the migration block above didn't run.
- // Create a writable copy and handle the SHARED_GLOBAL → SHARE inheritance here
- // to avoid removing SHARED_GLOBAL without writing SHARE (data loss).
- updatedPermissions[legacyPermType] = { ...existingTypePerms };
- if (!('SHARE' in existingTypePerms)) {
- updatedPermissions[legacyPermType]['SHARE'] = existingTypePerms['SHARED_GLOBAL'];
- logger.info(
- `Migrating '${roleName}' role ${legacyPermType}.SHARED_GLOBAL=${existingTypePerms['SHARED_GLOBAL']} → SHARE`,
- );
- }
- }
- delete updatedPermissions[legacyPermType]['SHARED_GLOBAL'];
- hasChanges = true;
- logger.info(
- `Removed legacy SHARED_GLOBAL field from '${roleName}' role ${legacyPermType} permissions`,
- );
- }
- }
-
- if (hasChanges) {
- const updateObj = { permissions: updatedPermissions };
-
- if (Object.keys(unsetFields).length > 0) {
- logger.info(
- `Unsetting old schema fields for '${roleName}' role: ${Object.keys(unsetFields).join(', ')}`,
- );
-
- try {
- await Role.updateOne(
- { name: roleName },
- {
- $set: updateObj,
- $unset: unsetFields,
- },
- );
-
- const cache = getLogStores(CacheKeys.ROLES);
- const updatedRole = await Role.findOne({ name: roleName }).select('-__v').lean().exec();
- await cache.set(roleName, updatedRole);
-
- logger.info(`Updated role '${roleName}' and removed old schema fields`);
- } catch (updateError) {
- logger.error(`Error during role migration update: ${updateError.message}`);
- throw updateError;
- }
- } else {
- // Standard update if no migration needed
- await updateRoleByName(roleName, updateObj);
- }
-
- logger.info(`Updated '${roleName}' role permissions`);
- } else {
- logger.info(`No changes needed for '${roleName}' role permissions`);
- }
- } catch (error) {
- logger.error(`Failed to update ${roleName} role permissions:`, error);
- }
-}
-
-/**
- * Migrates roles from old schema to new schema structure.
- * This can be called directly to fix existing roles.
- *
- * @param {string} [roleName] - Optional specific role to migrate. If not provided, migrates all roles.
- * @returns {Promise<number>} Number of roles migrated.
- */
-const migrateRoleSchema = async function (roleName) {
- try {
- // Get roles to migrate
- let roles;
- if (roleName) {
- const role = await Role.findOne({ name: roleName });
- roles = role ? [role] : [];
- } else {
- roles = await Role.find({});
- }
-
- logger.info(`Migrating ${roles.length} roles to new schema structure`);
- let migratedCount = 0;
-
- for (const role of roles) {
- const permissionTypes = Object.keys(permissionsSchema.shape || {});
- const unsetFields = {};
- let hasOldSchema = false;
-
- // Check for old schema fields
- for (const permType of permissionTypes) {
- if (role[permType] && typeof role[permType] === 'object') {
- hasOldSchema = true;
-
- // Ensure permissions object exists
- role.permissions = role.permissions || {};
-
- // Migrate permissions from old location to new
- role.permissions[permType] = {
- ...role.permissions[permType],
- ...role[permType],
- };
-
- // Mark field for removal
- unsetFields[permType] = 1;
- }
- }
-
- if (hasOldSchema) {
- try {
- logger.info(`Migrating role '${role.name}' from old schema structure`);
-
- // Simple update operation
- await Role.updateOne(
- { _id: role._id },
- {
- $set: { permissions: role.permissions },
- $unset: unsetFields,
- },
- );
-
- // Refresh cache
- const cache = getLogStores(CacheKeys.ROLES);
- const updatedRole = await Role.findById(role._id).lean().exec();
- await cache.set(role.name, updatedRole);
-
- migratedCount++;
- logger.info(`Migrated role '${role.name}'`);
- } catch (error) {
- logger.error(`Failed to migrate role '${role.name}': ${error.message}`);
- }
- }
- }
-
- logger.info(`Migration complete: ${migratedCount} roles migrated`);
- return migratedCount;
- } catch (error) {
- logger.error(`Role schema migration failed: ${error.message}`);
- throw error;
- }
-};
-
-module.exports = {
- getRoleByName,
- updateRoleByName,
- migrateRoleSchema,
- updateAccessPermissions,
-};
diff --git a/api/models/ToolCall.js b/api/models/ToolCall.js
deleted file mode 100644
index 689386114b..0000000000
--- a/api/models/ToolCall.js
+++ /dev/null
@@ -1,96 +0,0 @@
-const { ToolCall } = require('~/db/models');
-
-/**
- * Create a new tool call
- * @param {IToolCallData} toolCallData - The tool call data
- * @returns {Promise<IToolCallData>} The created tool call document
- */
-async function createToolCall(toolCallData) {
- try {
- return await ToolCall.create(toolCallData);
- } catch (error) {
- throw new Error(`Error creating tool call: ${error.message}`);
- }
-}
-
-/**
- * Get a tool call by ID
- * @param {string} id - The tool call document ID
- * @returns {Promise<IToolCallData|null>} The tool call document or null if not found
- */
-async function getToolCallById(id) {
- try {
- return await ToolCall.findById(id).lean();
- } catch (error) {
- throw new Error(`Error fetching tool call: ${error.message}`);
- }
-}
-
-/**
- * Get tool calls by message ID and user
- * @param {string} messageId - The message ID
- * @param {string} userId - The user's ObjectId
- * @returns {Promise<Array>} Array of tool call documents
- */
-async function getToolCallsByMessage(messageId, userId) {
- try {
- return await ToolCall.find({ messageId, user: userId }).lean();
- } catch (error) {
- throw new Error(`Error fetching tool calls: ${error.message}`);
- }
-}
-
-/**
- * Get tool calls by conversation ID and user
- * @param {string} conversationId - The conversation ID
- * @param {string} userId - The user's ObjectId
- * @returns {Promise<IToolCallData[]>} Array of tool call documents
- */
-async function getToolCallsByConvo(conversationId, userId) {
- try {
- return await ToolCall.find({ conversationId, user: userId }).lean();
- } catch (error) {
- throw new Error(`Error fetching tool calls: ${error.message}`);
- }
-}
-
-/**
- * Update a tool call
- * @param {string} id - The tool call document ID
- * @param {Partial<IToolCallData>} updateData - The data to update
- * @returns {Promise<IToolCallData|null>} The updated tool call document or null if not found
- */
-async function updateToolCall(id, updateData) {
- try {
- return await ToolCall.findByIdAndUpdate(id, updateData, { new: true }).lean();
- } catch (error) {
- throw new Error(`Error updating tool call: ${error.message}`);
- }
-}
-
-/**
- * Delete a tool call
- * @param {string} userId - The related user's ObjectId
- * @param {string} [conversationId] - The tool call conversation ID
- * @returns {Promise<{ ok?: number; n?: number; deletedCount?: number }>} The result of the delete operation
- */
-async function deleteToolCalls(userId, conversationId) {
- try {
- const query = { user: userId };
- if (conversationId) {
- query.conversationId = conversationId;
- }
- return await ToolCall.deleteMany(query);
- } catch (error) {
- throw new Error(`Error deleting tool call: ${error.message}`);
- }
-}
-
-module.exports = {
- createToolCall,
- updateToolCall,
- deleteToolCalls,
- getToolCallById,
- getToolCallsByConvo,
- getToolCallsByMessage,
-};
diff --git a/api/models/Transaction.js b/api/models/Transaction.js
deleted file mode 100644
index 7f018e1c30..0000000000
--- a/api/models/Transaction.js
+++ /dev/null
@@ -1,223 +0,0 @@
-const { logger, CANCEL_RATE } = require('@librechat/data-schemas');
-const { getMultiplier, getCacheMultiplier } = require('./tx');
-const { Transaction } = require('~/db/models');
-const { updateBalance } = require('~/models');
-
-/** Method to calculate and set the tokenValue for a transaction */
-function calculateTokenValue(txn) {
- const { valueKey, tokenType, model, endpointTokenConfig, inputTokenCount } = txn;
- const multiplier = Math.abs(
- getMultiplier({ valueKey, tokenType, model, endpointTokenConfig, inputTokenCount }),
- );
- txn.rate = multiplier;
- txn.tokenValue = txn.rawAmount * multiplier;
- if (txn.context && txn.tokenType === 'completion' && txn.context === 'incomplete') {
- txn.tokenValue = Math.ceil(txn.tokenValue * CANCEL_RATE);
- txn.rate *= CANCEL_RATE;
- }
-}
-
-/**
- * New static method to create an auto-refill transaction that does NOT trigger a balance update.
- * @param {object} txData - Transaction data.
- * @param {string} txData.user - The user ID.
- * @param {string} txData.tokenType - The type of token.
- * @param {string} txData.context - The context of the transaction.
- * @param {number} txData.rawAmount - The raw amount of tokens.
- * @returns {Promise<object>} - The created transaction.
- */
-async function createAutoRefillTransaction(txData) {
- if (txData.rawAmount != null && isNaN(txData.rawAmount)) {
- return;
- }
- const transaction = new Transaction(txData);
- transaction.endpointTokenConfig = txData.endpointTokenConfig;
- transaction.inputTokenCount = txData.inputTokenCount;
- calculateTokenValue(transaction);
- await transaction.save();
-
- const balanceResponse = await updateBalance({
- user: transaction.user,
- incrementValue: txData.rawAmount,
- setValues: { lastRefill: new Date() },
- });
- const result = {
- rate: transaction.rate,
- user: transaction.user.toString(),
- balance: balanceResponse.tokenCredits,
- };
- logger.debug('[Balance.check] Auto-refill performed', result);
- result.transaction = transaction;
- return result;
-}
-
-/**
- * Static method to create a transaction and update the balance
- * @param {txData} _txData - Transaction data.
- */
-async function createTransaction(_txData) {
- const { balance, transactions, ...txData } = _txData;
- if (txData.rawAmount != null && isNaN(txData.rawAmount)) {
- return;
- }
-
- if (transactions?.enabled === false) {
- return;
- }
-
- const transaction = new Transaction(txData);
- transaction.endpointTokenConfig = txData.endpointTokenConfig;
- transaction.inputTokenCount = txData.inputTokenCount;
- calculateTokenValue(transaction);
-
- await transaction.save();
- if (!balance?.enabled) {
- return;
- }
-
- let incrementValue = transaction.tokenValue;
- const balanceResponse = await updateBalance({
- user: transaction.user,
- incrementValue,
- });
-
- return {
- rate: transaction.rate,
- user: transaction.user.toString(),
- balance: balanceResponse.tokenCredits,
- [transaction.tokenType]: incrementValue,
- };
-}
-
-/**
- * Static method to create a structured transaction and update the balance
- * @param {txData} _txData - Transaction data.
- */
-async function createStructuredTransaction(_txData) {
- const { balance, transactions, ...txData } = _txData;
- if (transactions?.enabled === false) {
- return;
- }
-
- const transaction = new Transaction(txData);
- transaction.endpointTokenConfig = txData.endpointTokenConfig;
- transaction.inputTokenCount = txData.inputTokenCount;
-
- calculateStructuredTokenValue(transaction);
-
- await transaction.save();
-
- if (!balance?.enabled) {
- return;
- }
-
- let incrementValue = transaction.tokenValue;
-
- const balanceResponse = await updateBalance({
- user: transaction.user,
- incrementValue,
- });
-
- return {
- rate: transaction.rate,
- user: transaction.user.toString(),
- balance: balanceResponse.tokenCredits,
- [transaction.tokenType]: incrementValue,
- };
-}
-
-/** Method to calculate token value for structured tokens */
-function calculateStructuredTokenValue(txn) {
- if (!txn.tokenType) {
- txn.tokenValue = txn.rawAmount;
- return;
- }
-
- const { model, endpointTokenConfig, inputTokenCount } = txn;
-
- if (txn.tokenType === 'prompt') {
- const inputMultiplier = getMultiplier({
- tokenType: 'prompt',
- model,
- endpointTokenConfig,
- inputTokenCount,
- });
- const writeMultiplier =
- getCacheMultiplier({ cacheType: 'write', model, endpointTokenConfig }) ?? inputMultiplier;
- const readMultiplier =
- getCacheMultiplier({ cacheType: 'read', model, endpointTokenConfig }) ?? inputMultiplier;
-
- txn.rateDetail = {
- input: inputMultiplier,
- write: writeMultiplier,
- read: readMultiplier,
- };
-
- const totalPromptTokens =
- Math.abs(txn.inputTokens || 0) +
- Math.abs(txn.writeTokens || 0) +
- Math.abs(txn.readTokens || 0);
-
- if (totalPromptTokens > 0) {
- txn.rate =
- (Math.abs(inputMultiplier * (txn.inputTokens || 0)) +
- Math.abs(writeMultiplier * (txn.writeTokens || 0)) +
- Math.abs(readMultiplier * (txn.readTokens || 0))) /
- totalPromptTokens;
- } else {
- txn.rate = Math.abs(inputMultiplier); // Default to input rate if no tokens
- }
-
- txn.tokenValue = -(
- Math.abs(txn.inputTokens || 0) * inputMultiplier +
- Math.abs(txn.writeTokens || 0) * writeMultiplier +
- Math.abs(txn.readTokens || 0) * readMultiplier
- );
-
- txn.rawAmount = -totalPromptTokens;
- } else if (txn.tokenType === 'completion') {
- const multiplier = getMultiplier({
- tokenType: txn.tokenType,
- model,
- endpointTokenConfig,
- inputTokenCount,
- });
- txn.rate = Math.abs(multiplier);
- txn.tokenValue = -Math.abs(txn.rawAmount) * multiplier;
- txn.rawAmount = -Math.abs(txn.rawAmount);
- }
-
- if (txn.context && txn.tokenType === 'completion' && txn.context === 'incomplete') {
- txn.tokenValue = Math.ceil(txn.tokenValue * CANCEL_RATE);
- txn.rate *= CANCEL_RATE;
- if (txn.rateDetail) {
- txn.rateDetail = Object.fromEntries(
- Object.entries(txn.rateDetail).map(([k, v]) => [k, v * CANCEL_RATE]),
- );
- }
- }
-}
-
-/**
- * Queries and retrieves transactions based on a given filter.
- * @async
- * @function getTransactions
- * @param {Object} filter - MongoDB filter object to apply when querying transactions.
- * @returns {Promise<Array>} A promise that resolves to an array of matched transactions.
- * @throws {Error} Throws an error if querying the database fails.
- */
-async function getTransactions(filter) {
- try {
- return await Transaction.find(filter).lean();
- } catch (error) {
- logger.error('Error querying transactions:', error);
- throw error;
- }
-}
-
-module.exports = {
- getTransactions,
- createTransaction,
- createAutoRefillTransaction,
- createStructuredTransaction,
-};
diff --git a/api/models/balanceMethods.js b/api/models/balanceMethods.js
deleted file mode 100644
index e614872eac..0000000000
--- a/api/models/balanceMethods.js
+++ /dev/null
@@ -1,156 +0,0 @@
-const { logger } = require('@librechat/data-schemas');
-const { ViolationTypes } = require('librechat-data-provider');
-const { createAutoRefillTransaction } = require('./Transaction');
-const { logViolation } = require('~/cache');
-const { getMultiplier } = require('./tx');
-const { Balance } = require('~/db/models');
-
-function isInvalidDate(date) {
- return isNaN(date);
-}
-
-/**
- * Simple check method that calculates token cost and returns balance info.
- * The auto-refill logic has been moved to balanceMethods.js to prevent circular dependencies.
- */
-const checkBalanceRecord = async function ({
- user,
- model,
- endpoint,
- valueKey,
- tokenType,
- amount,
- endpointTokenConfig,
-}) {
- const multiplier = getMultiplier({ valueKey, tokenType, model, endpoint, endpointTokenConfig });
- const tokenCost = amount * multiplier;
-
- // Retrieve the balance record
- let record = await Balance.findOne({ user }).lean();
- if (!record) {
- logger.debug('[Balance.check] No balance record found for user', { user });
- return {
- canSpend: false,
- balance: 0,
- tokenCost,
- };
- }
- let balance = record.tokenCredits;
-
- logger.debug('[Balance.check] Initial state', {
- user,
- model,
- endpoint,
- valueKey,
- tokenType,
- amount,
- balance,
- multiplier,
- endpointTokenConfig: !!endpointTokenConfig,
- });
-
- // Only perform auto-refill if spending would bring the balance to 0 or below
- if (balance - tokenCost <= 0 && record.autoRefillEnabled && record.refillAmount > 0) {
- const lastRefillDate = new Date(record.lastRefill);
- const now = new Date();
- if (
- isInvalidDate(lastRefillDate) ||
- now >=
- addIntervalToDate(lastRefillDate, record.refillIntervalValue, record.refillIntervalUnit)
- ) {
- try {
- /** @type {{ rate: number, user: string, balance: number, transaction: import('@librechat/data-schemas').ITransaction}} */
- const result = await createAutoRefillTransaction({
- user: user,
- tokenType: 'credits',
- context: 'autoRefill',
- rawAmount: record.refillAmount,
- });
- balance = result.balance;
- } catch (error) {
- logger.error('[Balance.check] Failed to record transaction for auto-refill', error);
- }
- }
- }
-
- logger.debug('[Balance.check] Token cost', { tokenCost });
- return { canSpend: balance >= tokenCost, balance, tokenCost };
-};
-
-/**
- * Adds a time interval to a given date.
- * @param {Date} date - The starting date.
- * @param {number} value - The numeric value of the interval.
- * @param {'seconds'|'minutes'|'hours'|'days'|'weeks'|'months'} unit - The unit of time.
- * @returns {Date} A new Date representing the starting date plus the interval.
- */
-const addIntervalToDate = (date, value, unit) => {
- const result = new Date(date);
- switch (unit) {
- case 'seconds':
- result.setSeconds(result.getSeconds() + value);
- break;
- case 'minutes':
- result.setMinutes(result.getMinutes() + value);
- break;
- case 'hours':
- result.setHours(result.getHours() + value);
- break;
- case 'days':
- result.setDate(result.getDate() + value);
- break;
- case 'weeks':
- result.setDate(result.getDate() + value * 7);
- break;
- case 'months':
- result.setMonth(result.getMonth() + value);
- break;
- default:
- break;
- }
- return result;
-};
-
-/**
- * Checks the balance for a user and determines if they can spend a certain amount.
- * If the user cannot spend the amount, it logs a violation and denies the request.
- *
- * @async
- * @function
- * @param {Object} params - The function parameters.
- * @param {ServerRequest} params.req - The Express request object.
- * @param {Express.Response} params.res - The Express response object.
- * @param {Object} params.txData - The transaction data.
- * @param {string} params.txData.user - The user ID or identifier.
- * @param {('prompt' | 'completion')} params.txData.tokenType - The type of token.
- * @param {number} params.txData.amount - The amount of tokens.
- * @param {string} params.txData.model - The model name or identifier.
- * @param {string} [params.txData.endpointTokenConfig] - The token configuration for the endpoint.
- * @returns {Promise<boolean>} Throws error if the user cannot spend the amount.
- * @throws {Error} Throws an error if there's an issue with the balance check.
- */
-const checkBalance = async ({ req, res, txData }) => {
- const { canSpend, balance, tokenCost } = await checkBalanceRecord(txData);
- if (canSpend) {
- return true;
- }
-
- const type = ViolationTypes.TOKEN_BALANCE;
- const errorMessage = {
- type,
- balance,
- tokenCost,
- promptTokens: txData.amount,
- };
-
- if (txData.generations && txData.generations.length > 0) {
- errorMessage.generations = txData.generations;
- }
-
- await logViolation(req, res, type, errorMessage, 0);
- throw new Error(JSON.stringify(errorMessage));
-};
-
-module.exports = {
- checkBalance,
-};
diff --git a/api/models/index.js b/api/models/index.js
index d0b10be079..03d5d3ec71 100644
--- a/api/models/index.js
+++ b/api/models/index.js
@@ -1,19 +1,13 @@
const mongoose = require('mongoose');
const { createMethods } = require('@librechat/data-schemas');
-const methods = createMethods(mongoose);
-const { comparePassword } = require('./userMethods');
-const {
- getMessage,
- getMessages,
- saveMessage,
- recordMessage,
- updateMessage,
- deleteMessagesSince,
- deleteMessages,
-} = require('./Message');
-const { getConvoTitle, getConvo, saveConvo, deleteConvos } = require('./Conversation');
-const { getPreset, getPresets, savePreset, deletePresets } = require('./Preset');
-const { File } = require('~/db/models');
+const { matchModelName, findMatchingPattern } = require('@librechat/api');
+const getLogStores = require('~/cache/getLogStores');
+
+const methods = createMethods(mongoose, {
+ matchModelName,
+ findMatchingPattern,
+ getCache: getLogStores,
+});
const seedDatabase = async () => {
await methods.initializeRoles();
@@ -24,25 +18,4 @@ const seedDatabase = async () => {
module.exports = {
...methods,
seedDatabase,
- comparePassword,
-
- getMessage,
- getMessages,
- saveMessage,
- recordMessage,
- updateMessage,
- deleteMessagesSince,
- deleteMessages,
-
- getConvoTitle,
- getConvo,
- saveConvo,
- deleteConvos,
-
- getPreset,
- getPresets,
- savePreset,
- deletePresets,
-
- Files: File,
};
diff --git a/api/models/interface.js b/api/models/interface.js
deleted file mode 100644
index a79a8e747f..0000000000
--- a/api/models/interface.js
+++ /dev/null
@@ -1,24 +0,0 @@
-const { logger } = require('@librechat/data-schemas');
-const { updateInterfacePermissions: updateInterfacePerms } = require('@librechat/api');
-const { getRoleByName, updateAccessPermissions } = require('./Role');
-
-/**
- * Update interface permissions based on app configuration.
- * Must be done independently from loading the app config.
- * @param {AppConfig} appConfig
- */
-async function updateInterfacePermissions(appConfig) {
- try {
- await updateInterfacePerms({
- appConfig,
- getRoleByName,
- updateAccessPermissions,
- });
- } catch (error) {
- logger.error('Error updating interface permissions:', error);
- }
-}
-
-module.exports = {
- updateInterfacePermissions,
-};
diff --git a/api/models/inviteUser.js b/api/models/inviteUser.js
deleted file mode 100644
index eda8394225..0000000000
--- a/api/models/inviteUser.js
+++ /dev/null
@@ -1,68 +0,0 @@
-const mongoose = require('mongoose');
-const { logger, hashToken, getRandomValues } = require('@librechat/data-schemas');
-const { createToken, findToken } = require('~/models');
-
-/**
- * @module inviteUser
- * @description This module provides functions to create and get user invites
- */
-
-/**
- * @function createInvite
- * @description This function creates a new user invite
- * @param {string} email - The email of the user to invite
- * @returns {Promise<Object>} A promise that resolves to the saved invite document
- * @throws {Error} If there is an error creating the invite
- */
-const createInvite = async (email) => {
- try {
- const token = await getRandomValues(32);
- const hash = await hashToken(token);
- const encodedToken = encodeURIComponent(token);
-
- const fakeUserId = new mongoose.Types.ObjectId();
-
- await createToken({
- userId: fakeUserId,
- email,
- token: hash,
- createdAt: Date.now(),
- expiresIn: 604800,
- });
-
- return encodedToken;
- } catch (error) {
- logger.error('[createInvite] Error creating invite', error);
- return { message: 'Error creating invite' };
- }
-};
-
-/**
- * @function getInvite
- * @description This function retrieves a user invite
- * @param {string} encodedToken - The token of the invite to retrieve
- * @param {string} email - The email of the user to validate
- * @returns {Promise<Object>} A promise that resolves to the retrieved invite document
- * @throws {Error} If there is an error retrieving the invite, if the invite does not exist, or if the email does not match
- */
-const getInvite = async (encodedToken, email) => {
- try {
- const token = decodeURIComponent(encodedToken);
- const hash = await hashToken(token);
- const invite = await findToken({ token: hash, email });
-
- if (!invite) {
- throw new Error('Invite not found or email does not match');
- }
-
- return invite;
- } catch (error) {
- logger.error('[getInvite] Error getting invite:', error);
- return { error: true, message: error.message };
- }
-};
-
-module.exports = {
- createInvite,
- getInvite,
-};
diff --git a/api/models/loadAddedAgent.js b/api/models/loadAddedAgent.js
deleted file mode 100644
index 101ee96685..0000000000
--- a/api/models/loadAddedAgent.js
+++ /dev/null
@@ -1,218 +0,0 @@
-const { logger } = require('@librechat/data-schemas');
-const { getCustomEndpointConfig } = require('@librechat/api');
-const {
- Tools,
- Constants,
- isAgentsEndpoint,
- isEphemeralAgentId,
- appendAgentIdSuffix,
- encodeEphemeralAgentId,
-} = require('librechat-data-provider');
-const { getMCPServerTools } = require('~/server/services/Config');
-
-const { mcp_all, mcp_delimiter } = Constants;
-
-/**
- * Constant for added conversation agent ID
- */
-const ADDED_AGENT_ID = 'added_agent';
-
-/**
- * Get an agent document based on the provided ID.
- * @param {Object} searchParameter - The search parameters to find the agent.
- * @param {string} searchParameter.id - The ID of the agent.
- * @returns {Promise<import('librechat-data-provider').Agent|null>}
- */
-let getAgent;
-
-/**
- * Set the getAgent function (dependency injection to avoid circular imports)
- * @param {Function} fn
- */
-const setGetAgent = (fn) => {
- getAgent = fn;
-};
-
-/**
- * Load an agent from an added conversation (TConversation).
- * Used for multi-convo parallel agent execution.
- *
- * @param {Object} params
- * @param {import('express').Request} params.req
- * @param {import('librechat-data-provider').TConversation} params.conversation - The added conversation
- * @param {import('librechat-data-provider').Agent} [params.primaryAgent] - The primary agent (used to duplicate tools when both are ephemeral)
- * @returns {Promise<import('librechat-data-provider').Agent|null>} The agent config as a plain object, or null if invalid.
- */
-const loadAddedAgent = async ({ req, conversation, primaryAgent }) => {
- if (!conversation) {
- return null;
- }
-
- if (conversation.agent_id && !isEphemeralAgentId(conversation.agent_id)) {
- let agent = req.resolvedAddedAgent;
- if (!agent) {
- if (!getAgent) {
- throw new Error('getAgent not initialized - call setGetAgent first');
- }
- agent = await getAgent({ id: conversation.agent_id });
- }
-
- if (!agent) {
- logger.warn(`[loadAddedAgent] Agent ${conversation.agent_id} not found`);
- return null;
- }
-
- agent.version = agent.versions ? agent.versions.length : 0;
- // Append suffix to distinguish from primary agent (matches ephemeral format)
- // This is needed when both agents have the same ID or for consistent parallel content attribution
- agent.id = appendAgentIdSuffix(agent.id, 1);
- return agent;
- }
-
- // Otherwise, create an ephemeral agent config from the conversation
- const { model, endpoint, promptPrefix, spec, ...rest } = conversation;
-
- if (!endpoint || !model) {
- logger.warn('[loadAddedAgent] Missing required endpoint or model for ephemeral agent');
- return null;
- }
-
- // If both primary and added agents are ephemeral, duplicate tools from primary agent
- const primaryIsEphemeral = primaryAgent && isEphemeralAgentId(primaryAgent.id);
- if (primaryIsEphemeral && Array.isArray(primaryAgent.tools)) {
- // Get endpoint config and model spec for display name fallbacks
- const appConfig = req.config;
- let endpointConfig = appConfig?.endpoints?.[endpoint];
- if (!isAgentsEndpoint(endpoint) && !endpointConfig) {
- try {
- endpointConfig = getCustomEndpointConfig({ endpoint, appConfig });
- } catch (err) {
- logger.error('[loadAddedAgent] Error getting custom endpoint config', err);
- }
- }
-
- // Look up model spec for label fallback
- const modelSpecs = appConfig?.modelSpecs?.list;
- const modelSpec = spec != null && spec !== '' ? modelSpecs?.find((s) => s.name === spec) : null;
-
- // For ephemeral agents, use modelLabel if provided, then model spec's label,
- // then modelDisplayLabel from endpoint config, otherwise empty string to show model name
- const sender = rest.modelLabel ?? modelSpec?.label ?? endpointConfig?.modelDisplayLabel ?? '';
-
- const ephemeralId = encodeEphemeralAgentId({ endpoint, model, sender, index: 1 });
-
- return {
- id: ephemeralId,
- instructions: promptPrefix || '',
- provider: endpoint,
- model_parameters: {},
- model,
- tools: [...primaryAgent.tools],
- };
- }
-
- // Extract ephemeral agent options from conversation if present
- const ephemeralAgent = rest.ephemeralAgent;
- const mcpServers = new Set(ephemeralAgent?.mcp);
- const userId = req.user?.id;
-
- // Check model spec for MCP servers
- const modelSpecs = req.config?.modelSpecs?.list;
- let modelSpec = null;
- if (spec != null && spec !== '') {
- modelSpec = modelSpecs?.find((s) => s.name === spec) || null;
- }
- if (modelSpec?.mcpServers) {
- for (const mcpServer of modelSpec.mcpServers) {
- mcpServers.add(mcpServer);
- }
- }
-
- /** @type {string[]} */
- const tools = [];
- if (ephemeralAgent?.execute_code === true || modelSpec?.executeCode === true) {
- tools.push(Tools.execute_code);
- }
- if (ephemeralAgent?.file_search === true || modelSpec?.fileSearch === true) {
- tools.push(Tools.file_search);
- }
- if (ephemeralAgent?.web_search === true || modelSpec?.webSearch === true) {
- tools.push(Tools.web_search);
- }
-
- const addedServers = new Set();
- if (mcpServers.size > 0) {
- for (const mcpServer of mcpServers) {
- if (addedServers.has(mcpServer)) {
- continue;
- }
- const serverTools = await getMCPServerTools(userId, mcpServer);
- if (!serverTools) {
- tools.push(`${mcp_all}${mcp_delimiter}${mcpServer}`);
- addedServers.add(mcpServer);
- continue;
- }
- tools.push(...Object.keys(serverTools));
- addedServers.add(mcpServer);
- }
- }
-
- // Build model_parameters from conversation fields
- const model_parameters = {};
- const paramKeys = [
- 'temperature',
- 'top_p',
- 'topP',
- 'topK',
- 'presence_penalty',
- 'frequency_penalty',
- 'maxOutputTokens',
- 'maxTokens',
- 'max_tokens',
- ];
-
- for (const key of paramKeys) {
- if (rest[key] != null) {
- model_parameters[key] = rest[key];
- }
- }
-
- // Get endpoint config for modelDisplayLabel fallback
- const appConfig = req.config;
- let endpointConfig = appConfig?.endpoints?.[endpoint];
- if (!isAgentsEndpoint(endpoint) && !endpointConfig) {
- try {
- endpointConfig = getCustomEndpointConfig({ endpoint, appConfig });
- } catch (err) {
- logger.error('[loadAddedAgent] Error getting custom endpoint config', err);
- }
- }
-
- // For ephemeral agents, use modelLabel if provided, then model spec's label,
- // then modelDisplayLabel from endpoint config, otherwise empty string to show model name
- const sender = rest.modelLabel ?? modelSpec?.label ?? endpointConfig?.modelDisplayLabel ?? '';
-
- /** Encoded ephemeral agent ID with endpoint, model, sender, and index=1 to distinguish from primary */
- const ephemeralId = encodeEphemeralAgentId({ endpoint, model, sender, index: 1 });
-
- const result = {
- id: ephemeralId,
- instructions: promptPrefix || '',
- provider: endpoint,
- model_parameters,
- model,
- tools,
- };
-
- if (ephemeralAgent?.artifacts != null && ephemeralAgent.artifacts) {
- result.artifacts = ephemeralAgent.artifacts;
- }
-
- return result;
-};
-
-module.exports = {
- ADDED_AGENT_ID,
- loadAddedAgent,
- setGetAgent,
-};
diff --git a/api/models/spendTokens.js b/api/models/spendTokens.js
deleted file mode 100644
index afe05969d8..0000000000
--- a/api/models/spendTokens.js
+++ /dev/null
@@ -1,140 +0,0 @@
-const { logger } = require('@librechat/data-schemas');
-const { createTransaction, createStructuredTransaction } = require('./Transaction');
-/**
- * Creates up to two transactions to record the spending of tokens.
- *
- * @function
- * @async
- * @param {txData} txData - Transaction data.
- * @param {Object} tokenUsage - The number of tokens used.
- * @param {Number} tokenUsage.promptTokens - The number of prompt tokens used.
- * @param {Number} tokenUsage.completionTokens - The number of completion tokens used.
- * @returns {Promise<void>} - Returns nothing.
- * @throws {Error} - Throws an error if there's an issue creating the transactions.
- */
-const spendTokens = async (txData, tokenUsage) => {
- const { promptTokens, completionTokens } = tokenUsage;
- logger.debug(
- `[spendTokens] conversationId: ${txData.conversationId}${
- txData?.context ? ` | Context: ${txData?.context}` : ''
- } | Token usage: `,
- {
- promptTokens,
- completionTokens,
- },
- );
- let prompt, completion;
- const normalizedPromptTokens = Math.max(promptTokens ?? 0, 0);
- try {
- if (promptTokens !== undefined) {
- prompt = await createTransaction({
- ...txData,
- tokenType: 'prompt',
- rawAmount: promptTokens === 0 ? 0 : -normalizedPromptTokens,
- inputTokenCount: normalizedPromptTokens,
- });
- }
-
- if (completionTokens !== undefined) {
- completion = await createTransaction({
- ...txData,
- tokenType: 'completion',
- rawAmount: completionTokens === 0 ? 0 : -Math.max(completionTokens, 0),
- inputTokenCount: normalizedPromptTokens,
- });
- }
-
- if (prompt || completion) {
- logger.debug('[spendTokens] Transaction data record against balance:', {
- user: txData.user,
- prompt: prompt?.prompt,
- promptRate: prompt?.rate,
- completion: completion?.completion,
- completionRate: completion?.rate,
- balance: completion?.balance ?? prompt?.balance,
- });
- } else {
- logger.debug('[spendTokens] No transactions incurred against balance');
- }
- } catch (err) {
- logger.error('[spendTokens]', err);
- }
-};
-
-/**
- * Creates transactions to record the spending of structured tokens.
- *
- * @function
- * @async
- * @param {txData} txData - Transaction data.
- * @param {Object} tokenUsage - The number of tokens used.
- * @param {Object} tokenUsage.promptTokens - The number of prompt tokens used.
- * @param {Number} tokenUsage.promptTokens.input - The number of input tokens.
- * @param {Number} tokenUsage.promptTokens.write - The number of write tokens.
- * @param {Number} tokenUsage.promptTokens.read - The number of read tokens.
- * @param {Number} tokenUsage.completionTokens - The number of completion tokens used.
- * @returns {Promise<void>} - Returns nothing.
- * @throws {Error} - Throws an error if there's an issue creating the transactions.
- */
-const spendStructuredTokens = async (txData, tokenUsage) => {
- const { promptTokens, completionTokens } = tokenUsage;
- logger.debug(
- `[spendStructuredTokens] conversationId: ${txData.conversationId}${
- txData?.context ? ` | Context: ${txData?.context}` : ''
- } | Token usage: `,
- {
- promptTokens,
- completionTokens,
- },
- );
- let prompt, completion;
- try {
- if (promptTokens) {
- const input = Math.max(promptTokens.input ?? 0, 0);
- const write = Math.max(promptTokens.write ?? 0, 0);
- const read = Math.max(promptTokens.read ?? 0, 0);
- const totalInputTokens = input + write + read;
- prompt = await createStructuredTransaction({
- ...txData,
- tokenType: 'prompt',
- inputTokens: -input,
- writeTokens: -write,
- readTokens: -read,
- inputTokenCount: totalInputTokens,
- });
- }
-
- if (completionTokens) {
- const totalInputTokens = promptTokens
- ? Math.max(promptTokens.input ?? 0, 0) +
- Math.max(promptTokens.write ?? 0, 0) +
- Math.max(promptTokens.read ?? 0, 0)
- : undefined;
- completion = await createTransaction({
- ...txData,
- tokenType: 'completion',
- rawAmount: -Math.max(completionTokens, 0),
- inputTokenCount: totalInputTokens,
- });
- }
-
- if (prompt || completion) {
- logger.debug('[spendStructuredTokens] Transaction data record against balance:', {
- user: txData.user,
- prompt: prompt?.prompt,
- promptRate: prompt?.rate,
- completion: completion?.completion,
- completionRate: completion?.rate,
- balance: completion?.balance ?? prompt?.balance,
- });
- } else {
- logger.debug('[spendStructuredTokens] No transactions incurred against balance');
- }
- } catch (err) {
- logger.error('[spendStructuredTokens]', err);
- }
-
- return { prompt, completion };
-};
-
-module.exports = { spendTokens, spendStructuredTokens };
diff --git a/api/models/userMethods.js b/api/models/userMethods.js
deleted file mode 100644
index b57b24e641..0000000000
--- a/api/models/userMethods.js
+++ /dev/null
@@ -1,31 +0,0 @@
-const bcrypt = require('bcryptjs');
-
-/**
- * Compares the provided password with the user's password.
- *
- * @param {IUser} user - The user to compare the password for.
- * @param {string} candidatePassword - The password to test against the user's password.
- * @returns {Promise<boolean>} A promise that resolves to a boolean indicating if the password matches.
- */
-const comparePassword = async (user, candidatePassword) => {
- if (!user) {
- throw new Error('No user provided');
- }
-
- if (!user.password) {
- throw new Error('No password, likely an email first registered via Social/OIDC login');
- }
-
- return new Promise((resolve, reject) => {
- bcrypt.compare(candidatePassword, user.password, (err, isMatch) => {
- if (err) {
- reject(err);
- }
- resolve(isMatch);
- });
- });
-};
-
-module.exports = {
- comparePassword,
-};
diff --git a/api/server/controllers/Balance.js b/api/server/controllers/Balance.js
index c892a73b0c..fd9b32e74c 100644
--- a/api/server/controllers/Balance.js
+++ b/api/server/controllers/Balance.js
@@ -1,24 +1,22 @@
-const { Balance } = require('~/db/models');
+const { findBalanceByUser } = require('~/models');
async function balanceController(req, res) {
- const balanceData = await Balance.findOne(
- { user: req.user.id },
- '-_id tokenCredits autoRefillEnabled refillIntervalValue refillIntervalUnit lastRefill refillAmount',
- ).lean();
+ const balanceData = await findBalanceByUser(req.user.id);
if (!balanceData) {
return res.status(404).json({ error: 'Balance not found' });
}
- // If auto-refill is not enabled, remove auto-refill related fields from the response
- if (!balanceData.autoRefillEnabled) {
- delete balanceData.refillIntervalValue;
- delete balanceData.refillIntervalUnit;
- delete balanceData.lastRefill;
- delete balanceData.refillAmount;
+ const { _id: _, ...result } = balanceData;
+
+ if (!result.autoRefillEnabled) {
+ delete result.refillIntervalValue;
+ delete result.refillIntervalUnit;
+ delete result.lastRefill;
+ delete result.refillAmount;
}
- res.status(200).json(balanceData);
+ res.status(200).json(result);
}
module.exports = balanceController;
diff --git a/api/server/controllers/PermissionsController.js b/api/server/controllers/PermissionsController.js
index 16930c5139..59732572c0 100644
--- a/api/server/controllers/PermissionsController.js
+++ b/api/server/controllers/PermissionsController.js
@@ -9,16 +9,19 @@ const { enrichRemoteAgentPrincipals, backfillRemoteAgentPermissions } = require(
const {
bulkUpdateResourcePermissions,
ensureGroupPrincipalExists,
+ getResourcePermissionsMap,
+ findAccessibleResources,
getEffectivePermissions,
ensurePrincipalExists,
getAvailableRoles,
- findAccessibleResources,
- getResourcePermissionsMap,
} = require('~/server/services/PermissionService');
const {
searchPrincipals: searchLocalPrincipals,
sortPrincipalsByRelevance,
calculateRelevanceScore,
+ findRoleByIdentifier,
+ aggregateAclEntries,
+ bulkWriteAclEntries,
} = require('~/models');
const {
entraIdPrincipalFeatureEnabled,
@@ -217,8 +220,7 @@ const getResourcePermissions = async (req, res) => {
const { resourceType, resourceId } = req.params;
validateResourceType(resourceType);
- // Use aggregation pipeline for efficient single-query data retrieval
- const results = await AclEntry.aggregate([
+ const results = await aggregateAclEntries([
// Match ACL entries for this resource
{
$match: {
@@ -314,7 +316,12 @@ const getResourcePermissions = async (req, res) => {
}
if (resourceType === ResourceType.REMOTE_AGENT) {
- const enricherDeps = { AclEntry, AccessRole, logger };
+ const enricherDeps = {
+ aggregateAclEntries,
+ bulkWriteAclEntries,
+ findRoleByIdentifier,
+ logger,
+ };
const enrichResult = await enrichRemoteAgentPrincipals(enricherDeps, resourceId, principals);
principals = enrichResult.principals;
backfillRemoteAgentPermissions(enricherDeps, resourceId, enrichResult.entriesToBackfill);
diff --git a/api/server/controllers/UserController.js b/api/server/controllers/UserController.js
index 48f34479cd..4a1c9135ab 100644
--- a/api/server/controllers/UserController.js
+++ b/api/server/controllers/UserController.js
@@ -13,34 +13,6 @@ const {
FileSources,
ResourceType,
} = require('librechat-data-provider');
-const {
- deleteAllUserSessions,
- deleteAllSharedLinks,
- updateUserPlugins,
- deleteUserById,
- deleteMessages,
- deletePresets,
- deleteUserKey,
- getUserById,
- deleteConvos,
- deleteFiles,
- updateUser,
- findToken,
- getFiles,
-} = require('~/models');
-const {
- ConversationTag,
- AgentApiKey,
- Transaction,
- MemoryEntry,
- Assistant,
- AclEntry,
- Balance,
- Action,
- Group,
- Token,
- User,
-} = require('~/db/models');
const { updateUserPluginAuth, deleteUserPluginAuth } = require('~/server/services/PluginService');
const { verifyOTPOrBackupCode } = require('~/server/services/twoFactorService');
const { verifyEmail, resendVerificationEmail } = require('~/server/services/AuthService');
@@ -49,11 +21,9 @@ const { invalidateCachedTools } = require('~/server/services/Config/getCachedToo
const { needsRefresh, getNewS3URL } = require('~/server/services/Files/S3/crud');
const { processDeleteRequest } = require('~/server/services/Files/process');
const { getAppConfig } = require('~/server/services/Config');
-const { deleteToolCalls } = require('~/models/ToolCall');
-const { deleteUserPrompts } = require('~/models/Prompt');
-const { deleteUserAgents } = require('~/models/Agent');
const { getSoleOwnedResourceIds } = require('~/server/services/PermissionService');
const { getLogStores } = require('~/cache');
+const db = require('~/models');
const getUserController = async (req, res) => {
const appConfig = await getAppConfig({ role: req.user?.role });
@@ -74,7 +44,7 @@ const getUserController = async (req, res) => {
const originalAvatar = userData.avatar;
try {
userData.avatar = await getNewS3URL(userData.avatar);
- await updateUser(userData.id, { avatar: userData.avatar });
+ await db.updateUser(userData.id, { avatar: userData.avatar });
} catch (error) {
userData.avatar = originalAvatar;
logger.error('Error getting new S3 URL for avatar:', error);
@@ -85,7 +55,7 @@ const getUserController = async (req, res) => {
const getTermsStatusController = async (req, res) => {
try {
- const user = await User.findById(req.user.id);
+ const user = await db.getUserById(req.user.id, 'termsAccepted');
if (!user) {
return res.status(404).json({ message: 'User not found' });
}
@@ -98,7 +68,7 @@ const getTermsStatusController = async (req, res) => {
const acceptTermsController = async (req, res) => {
try {
- const user = await User.findByIdAndUpdate(req.user.id, { termsAccepted: true }, { new: true });
+ const user = await db.updateUser(req.user.id, { termsAccepted: true });
if (!user) {
return res.status(404).json({ message: 'User not found' });
}
@@ -111,7 +81,7 @@ const acceptTermsController = async (req, res) => {
const deleteUserFiles = async (req) => {
try {
- const userFiles = await getFiles({ user: req.user.id });
+ const userFiles = await db.getFiles({ user: req.user.id });
await processDeleteRequest({
req,
files: userFiles,
@@ -134,6 +104,7 @@ const deleteUserFiles = async (req) => {
const deleteUserMcpServers = async (userId) => {
try {
const MCPServer = mongoose.models.MCPServer;
+ const AclEntry = mongoose.models.AclEntry;
if (!MCPServer) {
return;
}
@@ -199,7 +170,7 @@ const updateUserPluginsController = async (req, res) => {
const { pluginKey, action, auth, isEntityTool } = req.body;
try {
if (!isEntityTool) {
- await updateUserPlugins(user._id, user.plugins, pluginKey, action);
+ await db.updateUserPlugins(user._id, user.plugins, pluginKey, action);
}
if (auth == null) {
@@ -323,7 +294,7 @@ const deleteUserController = async (req, res) => {
const { user } = req;
try {
- const existingUser = await getUserById(
+ const existingUser = await db.getUserById(
user.id,
'+totpSecret +backupCodes _id twoFactorEnabled',
);
@@ -339,34 +310,34 @@ const deleteUserController = async (req, res) => {
}
}
- await deleteMessages({ user: user.id }); // delete user messages
- await deleteAllUserSessions({ userId: user.id }); // delete user sessions
- await Transaction.deleteMany({ user: user.id }); // delete user transactions
- await deleteUserKey({ userId: user.id, all: true }); // delete user keys
- await Balance.deleteMany({ user: user._id }); // delete user balances
- await deletePresets(user.id); // delete user presets
+ await db.deleteMessages({ user: user.id });
+ await db.deleteAllUserSessions({ userId: user.id });
+ await db.deleteTransactions({ user: user.id });
+ await db.deleteUserKey({ userId: user.id, all: true });
+ await db.deleteBalances({ user: user._id });
+ await db.deletePresets(user.id);
try {
- await deleteConvos(user.id); // delete user convos
+ await db.deleteConvos(user.id);
} catch (error) {
logger.error('[deleteUserController] Error deleting user convos, likely no convos', error);
}
- await deleteUserPluginAuth(user.id, null, true); // delete user plugin auth
- await deleteUserById(user.id); // delete user
- await deleteAllSharedLinks(user.id); // delete user shared links
- await deleteUserFiles(req); // delete user files
- await deleteFiles(null, user.id); // delete database files in case of orphaned files from previous steps
- await deleteToolCalls(user.id); // delete user tool calls
- await deleteUserAgents(user.id); // delete user agents
- await AgentApiKey.deleteMany({ user: user._id }); // delete user agent API keys
- await Assistant.deleteMany({ user: user.id }); // delete user assistants
- await ConversationTag.deleteMany({ user: user.id }); // delete user conversation tags
- await MemoryEntry.deleteMany({ userId: user.id }); // delete user memory entries
- await deleteUserPrompts(user.id); // delete user prompts
- await deleteUserMcpServers(user.id); // delete user MCP servers
- await Action.deleteMany({ user: user.id }); // delete user actions
- await Token.deleteMany({ userId: user.id }); // delete user OAuth tokens
- await Group.updateMany({ memberIds: user.id }, { $pullAll: { memberIds: [user.id] } });
- await AclEntry.deleteMany({ principalId: user._id }); // delete user ACL entries
+ await deleteUserPluginAuth(user.id, null, true);
+ await db.deleteUserById(user.id);
+ await db.deleteAllSharedLinks(user.id);
+ await deleteUserFiles(req);
+ await db.deleteFiles(null, user.id);
+ await db.deleteToolCalls(user.id);
+ await db.deleteUserAgents(user.id);
+ await db.deleteAllAgentApiKeys(user._id);
+ await db.deleteAssistants({ user: user.id });
+ await db.deleteConversationTags({ user: user.id });
+ await db.deleteAllUserMemories(user.id);
+ await db.deleteUserPrompts(user.id);
+ await deleteUserMcpServers(user.id);
+ await db.deleteActions({ user: user.id });
+ await db.deleteTokens({ userId: user.id });
+ await db.removeUserFromAllGroups(user.id);
+ await db.deleteAclEntries({ principalId: user._id });
logger.info(`User deleted account. Email: ${user.email} ID: ${user.id}`);
res.status(200).send({ message: 'User deleted' });
} catch (err) {
@@ -426,7 +397,7 @@ const maybeUninstallOAuthMCP = async (userId, pluginKey, appConfig) => {
const clientTokenData = await MCPTokenStorage.getClientInfoAndMetadata({
userId,
serverName,
- findToken,
+ findToken: db.findToken,
});
if (clientTokenData == null) {
return;
@@ -437,7 +408,7 @@ const maybeUninstallOAuthMCP = async (userId, pluginKey, appConfig) => {
const tokens = await MCPTokenStorage.getTokens({
userId,
serverName,
- findToken,
+ findToken: db.findToken,
});
// 3. revoke OAuth tokens at the provider
@@ -496,7 +467,7 @@ const maybeUninstallOAuthMCP = async (userId, pluginKey, appConfig) => {
userId,
serverName,
deleteToken: async (filter) => {
- await Token.deleteOne(filter);
+ await db.deleteTokens(filter);
},
});
diff --git a/api/server/controllers/UserController.spec.js b/api/server/controllers/UserController.spec.js
index cf5d971e02..6c96f067b7 100644
--- a/api/server/controllers/UserController.spec.js
+++ b/api/server/controllers/UserController.spec.js
@@ -14,20 +14,40 @@ jest.mock('@librechat/data-schemas', () => {
};
});
-jest.mock('~/models', () => ({
- deleteAllUserSessions: jest.fn().mockResolvedValue(undefined),
- deleteAllSharedLinks: jest.fn().mockResolvedValue(undefined),
- updateUserPlugins: jest.fn(),
- deleteUserById: jest.fn().mockResolvedValue(undefined),
- deleteMessages: jest.fn().mockResolvedValue(undefined),
- deletePresets: jest.fn().mockResolvedValue(undefined),
- deleteUserKey: jest.fn().mockResolvedValue(undefined),
- deleteConvos: jest.fn().mockResolvedValue(undefined),
- deleteFiles: jest.fn().mockResolvedValue(undefined),
- updateUser: jest.fn(),
- findToken: jest.fn(),
- getFiles: jest.fn().mockResolvedValue([]),
-}));
+jest.mock('~/models', () => {
+ const _mongoose = require('mongoose');
+ return {
+ deleteAllUserSessions: jest.fn().mockResolvedValue(undefined),
+ deleteAllSharedLinks: jest.fn().mockResolvedValue(undefined),
+ deleteAllAgentApiKeys: jest.fn().mockResolvedValue(undefined),
+ deleteConversationTags: jest.fn().mockResolvedValue(undefined),
+ deleteAllUserMemories: jest.fn().mockResolvedValue(undefined),
+ deleteTransactions: jest.fn().mockResolvedValue(undefined),
+ deleteAclEntries: jest.fn().mockResolvedValue(undefined),
+ updateUserPlugins: jest.fn(),
+ deleteAssistants: jest.fn().mockResolvedValue(undefined),
+ deleteUserById: jest.fn().mockResolvedValue(undefined),
+ deleteUserPrompts: jest.fn().mockResolvedValue(undefined),
+ deleteMessages: jest.fn().mockResolvedValue(undefined),
+ deleteBalances: jest.fn().mockResolvedValue(undefined),
+ deleteActions: jest.fn().mockResolvedValue(undefined),
+ deletePresets: jest.fn().mockResolvedValue(undefined),
+ deleteUserKey: jest.fn().mockResolvedValue(undefined),
+ deleteToolCalls: jest.fn().mockResolvedValue(undefined),
+ deleteUserAgents: jest.fn().mockResolvedValue(undefined),
+ deleteTokens: jest.fn().mockResolvedValue(undefined),
+ deleteConvos: jest.fn().mockResolvedValue(undefined),
+ deleteFiles: jest.fn().mockResolvedValue(undefined),
+ updateUser: jest.fn(),
+ getUserById: jest.fn().mockResolvedValue(null),
+ findToken: jest.fn(),
+ getFiles: jest.fn().mockResolvedValue([]),
+ removeUserFromAllGroups: jest.fn().mockImplementation(async (userId) => {
+ const Group = _mongoose.models.Group;
+ await Group.updateMany({ memberIds: userId }, { $pullAll: { memberIds: [userId] } });
+ }),
+ };
+});
jest.mock('~/server/services/PluginService', () => ({
updateUserPluginAuth: jest.fn(),
@@ -55,18 +75,6 @@ jest.mock('~/server/services/Config', () => ({
getMCPServersRegistry: jest.fn(),
}));
-jest.mock('~/models/ToolCall', () => ({
- deleteToolCalls: jest.fn().mockResolvedValue(undefined),
-}));
-
-jest.mock('~/models/Prompt', () => ({
- deleteUserPrompts: jest.fn().mockResolvedValue(undefined),
-}));
-
-jest.mock('~/models/Agent', () => ({
- deleteUserAgents: jest.fn().mockResolvedValue(undefined),
-}));
-
jest.mock('~/cache', () => ({
getLogStores: jest.fn(),
}));
diff --git a/api/server/controllers/agents/__tests__/openai.spec.js b/api/server/controllers/agents/__tests__/openai.spec.js
index 50c61b7288..cc43387560 100644
--- a/api/server/controllers/agents/__tests__/openai.spec.js
+++ b/api/server/controllers/agents/__tests__/openai.spec.js
@@ -77,11 +77,6 @@ jest.mock('~/server/services/ToolService', () => ({
loadToolsForExecution: jest.fn().mockResolvedValue([]),
}));
-jest.mock('~/models/spendTokens', () => ({
- spendTokens: mockSpendTokens,
- spendStructuredTokens: mockSpendStructuredTokens,
-}));
-
const mockGetMultiplier = jest.fn().mockReturnValue(1);
const mockGetCacheMultiplier = jest.fn().mockReturnValue(null);
jest.mock('~/models/tx', () => ({
@@ -89,6 +84,7 @@ jest.mock('~/models/tx', () => ({
getCacheMultiplier: mockGetCacheMultiplier,
}));
+
jest.mock('~/server/controllers/agents/callbacks', () => ({
createToolEndCallback: jest.fn().mockReturnValue(jest.fn()),
}));
@@ -97,23 +93,11 @@ jest.mock('~/server/services/PermissionService', () => ({
findAccessibleResources: jest.fn().mockResolvedValue([]),
}));
-jest.mock('~/models/Conversation', () => ({
- getConvoFiles: jest.fn().mockResolvedValue([]),
- getConvo: jest.fn().mockResolvedValue(null),
-}));
-
-jest.mock('~/models/Agent', () => ({
- getAgent: jest.fn().mockResolvedValue({
- id: 'agent-123',
- provider: 'openAI',
- model_parameters: { model: 'gpt-4' },
- }),
- getAgents: jest.fn().mockResolvedValue([]),
-}));
-
const mockUpdateBalance = jest.fn().mockResolvedValue({});
const mockBulkInsertTransactions = jest.fn().mockResolvedValue(undefined);
+
jest.mock('~/models', () => ({
+ getAgent: jest.fn().mockResolvedValue({ id: 'agent-123', name: 'Test Agent' }),
getFiles: jest.fn(),
getUserKey: jest.fn(),
getMessages: jest.fn(),
@@ -124,6 +108,9 @@ jest.mock('~/models', () => ({
getCodeGeneratedFiles: jest.fn(),
updateBalance: mockUpdateBalance,
bulkInsertTransactions: mockBulkInsertTransactions,
+ spendTokens: mockSpendTokens,
+ spendStructuredTokens: mockSpendStructuredTokens,
+ getConvoFiles: jest.fn().mockResolvedValue([]),
}));
describe('OpenAIChatCompletionController', () => {
diff --git a/api/server/controllers/agents/__tests__/responses.unit.spec.js b/api/server/controllers/agents/__tests__/responses.unit.spec.js
index e34f0ccf73..604c28f74d 100644
--- a/api/server/controllers/agents/__tests__/responses.unit.spec.js
+++ b/api/server/controllers/agents/__tests__/responses.unit.spec.js
@@ -101,11 +101,6 @@ jest.mock('~/server/services/ToolService', () => ({
loadToolsForExecution: jest.fn().mockResolvedValue([]),
}));
-jest.mock('~/models/spendTokens', () => ({
- spendTokens: mockSpendTokens,
- spendStructuredTokens: mockSpendStructuredTokens,
-}));
-
const mockGetMultiplier = jest.fn().mockReturnValue(1);
const mockGetCacheMultiplier = jest.fn().mockReturnValue(null);
jest.mock('~/models/tx', () => ({
@@ -113,6 +108,7 @@ jest.mock('~/models/tx', () => ({
getCacheMultiplier: mockGetCacheMultiplier,
}));
+
jest.mock('~/server/controllers/agents/callbacks', () => ({
createToolEndCallback: jest.fn().mockReturnValue(jest.fn()),
createResponsesToolEndCallback: jest.fn().mockReturnValue(jest.fn()),
@@ -122,25 +118,11 @@ jest.mock('~/server/services/PermissionService', () => ({
findAccessibleResources: jest.fn().mockResolvedValue([]),
}));
-jest.mock('~/models/Conversation', () => ({
- getConvoFiles: jest.fn().mockResolvedValue([]),
- saveConvo: jest.fn().mockResolvedValue({}),
- getConvo: jest.fn().mockResolvedValue(null),
-}));
-
-jest.mock('~/models/Agent', () => ({
- getAgent: jest.fn().mockResolvedValue({
- id: 'agent-123',
- name: 'Test Agent',
- provider: 'anthropic',
- model_parameters: { model: 'claude-3' },
- }),
- getAgents: jest.fn().mockResolvedValue([]),
-}));
-
const mockUpdateBalance = jest.fn().mockResolvedValue({});
const mockBulkInsertTransactions = jest.fn().mockResolvedValue(undefined);
+
jest.mock('~/models', () => ({
+ getAgent: jest.fn().mockResolvedValue({ id: 'agent-123', name: 'Test Agent' }),
getFiles: jest.fn(),
getUserKey: jest.fn(),
getMessages: jest.fn().mockResolvedValue([]),
@@ -152,6 +134,11 @@ jest.mock('~/models', () => ({
getCodeGeneratedFiles: jest.fn(),
updateBalance: mockUpdateBalance,
bulkInsertTransactions: mockBulkInsertTransactions,
+ spendTokens: mockSpendTokens,
+ spendStructuredTokens: mockSpendStructuredTokens,
+ getConvoFiles: jest.fn().mockResolvedValue([]),
+ saveConvo: jest.fn().mockResolvedValue({}),
+ getConvo: jest.fn().mockResolvedValue(null),
}));
describe('createResponse controller', () => {
diff --git a/api/server/controllers/agents/__tests__/v1.spec.js b/api/server/controllers/agents/__tests__/v1.spec.js
index b7e7b67a22..39cf994fef 100644
--- a/api/server/controllers/agents/__tests__/v1.spec.js
+++ b/api/server/controllers/agents/__tests__/v1.spec.js
@@ -1,10 +1,8 @@
const { duplicateAgent } = require('../v1');
-const { getAgent, createAgent } = require('~/models/Agent');
-const { getActions } = require('~/models/Action');
+const { getAgent, createAgent, getActions } = require('~/models');
const { nanoid } = require('nanoid');
-jest.mock('~/models/Agent');
-jest.mock('~/models/Action');
+jest.mock('~/models');
jest.mock('nanoid');
describe('duplicateAgent', () => {
diff --git a/api/server/controllers/agents/client.js b/api/server/controllers/agents/client.js
index c454bd65cf..1724e20ada 100644
--- a/api/server/controllers/agents/client.js
+++ b/api/server/controllers/agents/client.js
@@ -22,6 +22,7 @@ const {
GenerationJobManager,
getTransactionsConfig,
createMemoryProcessor,
+ loadAgent: loadAgentFn,
createMultiAgentMapper,
filterMalformedContentParts,
} = require('@librechat/api');
@@ -45,18 +46,17 @@ const {
removeNullishValues,
} = require('librechat-data-provider');
const { filterFilesByAgentAccess } = require('~/server/services/Files/permissions');
-const { spendTokens, spendStructuredTokens } = require('~/models/spendTokens');
const { encodeAndFormat } = require('~/server/services/Files/images/encode');
const { updateBalance, bulkInsertTransactions } = require('~/models');
const { getMultiplier, getCacheMultiplier } = require('~/models/tx');
const { createContextHandlers } = require('~/app/clients/prompts');
-const { getConvoFiles } = require('~/models/Conversation');
+const { getMCPServerTools } = require('~/server/services/Config');
const BaseClient = require('~/app/clients/BaseClient');
-const { getRoleByName } = require('~/models/Role');
-const { loadAgent } = require('~/models/Agent');
const { getMCPManager } = require('~/config');
const db = require('~/models');
+const loadAgent = (params) => loadAgentFn(params, { getAgent: db.getAgent, getMCPServerTools });
+
class AgentClient extends BaseClient {
constructor(options = {}) {
super(null, options);
@@ -413,7 +413,7 @@ class AgentClient extends BaseClient {
user,
permissionType: PermissionTypes.MEMORIES,
permissions: [Permissions.USE],
- getRoleByName,
+ getRoleByName: db.getRoleByName,
});
if (!hasAccess) {
@@ -473,9 +473,9 @@ class AgentClient extends BaseClient {
},
},
{
- getConvoFiles,
getFiles: db.getFiles,
getUserKey: db.getUserKey,
+ getConvoFiles: db.getConvoFiles,
updateFilesUsage: db.updateFilesUsage,
getUserKeyValues: db.getUserKeyValues,
getToolFilesByIds: db.getToolFilesByIds,
@@ -631,8 +631,8 @@ class AgentClient extends BaseClient {
}) {
const result = await recordCollectedUsage(
{
- spendTokens,
- spendStructuredTokens,
+ spendTokens: db.spendTokens,
+ spendStructuredTokens: db.spendStructuredTokens,
pricing: { getMultiplier, getCacheMultiplier },
bulkWriteOps: { insertMany: bulkInsertTransactions, updateBalance },
},
@@ -1134,7 +1134,7 @@ class AgentClient extends BaseClient {
context = 'message',
}) {
try {
- await spendTokens(
+ await db.spendTokens(
{
model,
context,
@@ -1153,7 +1153,7 @@ class AgentClient extends BaseClient {
'reasoning_tokens' in usage &&
typeof usage.reasoning_tokens === 'number'
) {
- await spendTokens(
+ await db.spendTokens(
{
model,
balance,
diff --git a/api/server/controllers/agents/client.test.js b/api/server/controllers/agents/client.test.js
index 42481e1644..4e3d10e8e6 100644
--- a/api/server/controllers/agents/client.test.js
+++ b/api/server/controllers/agents/client.test.js
@@ -15,13 +15,15 @@ jest.mock('@librechat/api', () => ({
checkAccess: jest.fn(),
initializeAgent: jest.fn(),
createMemoryProcessor: jest.fn(),
+ loadAgent: jest.fn(),
}));
-jest.mock('~/models/Agent', () => ({
- loadAgent: jest.fn(),
+jest.mock('~/server/services/Config', () => ({
+ getMCPServerTools: jest.fn(),
}));
-jest.mock('~/models/Role', () => ({
+jest.mock('~/models', () => ({
+ getAgent: jest.fn(),
getRoleByName: jest.fn(),
}));
@@ -2138,7 +2140,7 @@ describe('AgentClient - titleConvo', () => {
};
mockCheckAccess = require('@librechat/api').checkAccess;
- mockLoadAgent = require('~/models/Agent').loadAgent;
+ mockLoadAgent = require('@librechat/api').loadAgent;
mockInitializeAgent = require('@librechat/api').initializeAgent;
mockCreateMemoryProcessor = require('@librechat/api').createMemoryProcessor;
});
@@ -2195,6 +2197,7 @@ describe('AgentClient - titleConvo', () => {
expect.objectContaining({
agent_id: differentAgentId,
}),
+ expect.any(Object),
);
expect(mockInitializeAgent).toHaveBeenCalledWith(
expect.objectContaining({
diff --git a/api/server/controllers/agents/errors.js b/api/server/controllers/agents/errors.js
index 54b296a5d2..b16ce75591 100644
--- a/api/server/controllers/agents/errors.js
+++ b/api/server/controllers/agents/errors.js
@@ -3,8 +3,8 @@ const { logger } = require('@librechat/data-schemas');
const { CacheKeys, ViolationTypes } = require('librechat-data-provider');
const { sendResponse } = require('~/server/middleware/error');
const { recordUsage } = require('~/server/services/Threads');
-const { getConvo } = require('~/models/Conversation');
const getLogStores = require('~/cache/getLogStores');
+const { getConvo } = require('~/models');
/**
* @typedef {Object} ErrorHandlerContext
diff --git a/api/server/controllers/agents/openai.js b/api/server/controllers/agents/openai.js
index 189cb29d8d..f1b199dede 100644
--- a/api/server/controllers/agents/openai.js
+++ b/api/server/controllers/agents/openai.js
@@ -24,10 +24,7 @@ const {
const { loadAgentTools, loadToolsForExecution } = require('~/server/services/ToolService');
const { createToolEndCallback } = require('~/server/controllers/agents/callbacks');
const { findAccessibleResources } = require('~/server/services/PermissionService');
-const { spendTokens, spendStructuredTokens } = require('~/models/spendTokens');
const { getMultiplier, getCacheMultiplier } = require('~/models/tx');
-const { getConvoFiles, getConvo } = require('~/models/Conversation');
-const { getAgent, getAgents } = require('~/models/Agent');
const db = require('~/models');
/**
@@ -139,7 +136,7 @@ const OpenAIChatCompletionController = async (req, res) => {
const agentId = request.model;
// Look up the agent
- const agent = await getAgent({ id: agentId });
+ const agent = await db.getAgent({ id: agentId });
if (!agent) {
return sendErrorResponse(
res,
@@ -221,7 +218,7 @@ const OpenAIChatCompletionController = async (req, res) => {
isInitialAgent: true,
},
{
- getConvoFiles,
+ getConvoFiles: db.getConvoFiles,
getFiles: db.getFiles,
getUserKey: db.getUserKey,
getMessages: db.getMessages,
@@ -511,8 +508,8 @@ const OpenAIChatCompletionController = async (req, res) => {
const transactionsConfig = getTransactionsConfig(appConfig);
recordCollectedUsage(
{
- spendTokens,
- spendStructuredTokens,
+ spendTokens: db.spendTokens,
+ spendStructuredTokens: db.spendStructuredTokens,
pricing: { getMultiplier, getCacheMultiplier },
bulkWriteOps: { insertMany: db.bulkInsertTransactions, updateBalance: db.updateBalance },
},
@@ -627,7 +624,7 @@ const ListModelsController = async (req, res) => {
// Get the accessible agents
let agents = [];
if (accessibleAgentIds.length > 0) {
- agents = await getAgents({ _id: { $in: accessibleAgentIds } });
+ agents = await db.getAgents({ _id: { $in: accessibleAgentIds } });
}
const models = agents.map((agent) => ({
@@ -670,7 +667,7 @@ const GetModelController = async (req, res) => {
return sendErrorResponse(res, 401, 'Authentication required', 'auth_error');
}
- const agent = await getAgent({ id: model });
+ const agent = await db.getAgent({ id: model });
if (!agent) {
return sendErrorResponse(
diff --git a/api/server/controllers/agents/recordCollectedUsage.spec.js b/api/server/controllers/agents/recordCollectedUsage.spec.js
index 21720023ca..2d4730c603 100644
--- a/api/server/controllers/agents/recordCollectedUsage.spec.js
+++ b/api/server/controllers/agents/recordCollectedUsage.spec.js
@@ -18,7 +18,7 @@ const mockRecordCollectedUsage = jest
.fn()
.mockResolvedValue({ input_tokens: 100, output_tokens: 50 });
-jest.mock('~/models/spendTokens', () => ({
+jest.mock('~/models', () => ({
spendTokens: (...args) => mockSpendTokens(...args),
spendStructuredTokens: (...args) => mockSpendStructuredTokens(...args),
}));
diff --git a/api/server/controllers/agents/request.js b/api/server/controllers/agents/request.js
index dea5400036..6f7e1b88c1 100644
--- a/api/server/controllers/agents/request.js
+++ b/api/server/controllers/agents/request.js
@@ -131,9 +131,15 @@ const ResumableAgentController = async (req, res, next, initializeClient, addTit
partialMessage.agent_id = req.body.agent_id;
}
- await saveMessage(req, partialMessage, {
- context: 'api/server/controllers/agents/request.js - partial response on disconnect',
- });
+ await saveMessage(
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
+ partialMessage,
+ { context: 'api/server/controllers/agents/request.js - partial response on disconnect' },
+ );
logger.debug(
`[ResumableAgentController] Saved partial response for ${streamId}, content parts: ${aggregatedContent.length}`,
@@ -271,8 +277,14 @@ const ResumableAgentController = async (req, res, next, initializeClient, addTit
// Save user message BEFORE sending final event to avoid race condition
// where client refetch happens before database is updated
+ const reqCtx = {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ };
+
if (!client.skipSaveUserMessage && userMessage) {
- await saveMessage(req, userMessage, {
+ await saveMessage(reqCtx, userMessage, {
context: 'api/server/controllers/agents/request.js - resumable user message',
});
}
@@ -282,7 +294,7 @@ const ResumableAgentController = async (req, res, next, initializeClient, addTit
// before the response is saved to the database, causing orphaned parentMessageIds.
if (client.savedMessageIds && !client.savedMessageIds.has(messageId)) {
await saveMessage(
- req,
+ reqCtx,
{ ...response, user: userId, unfinished: wasAbortedBeforeComplete },
{ context: 'api/server/controllers/agents/request.js - resumable response end' },
);
@@ -661,7 +673,11 @@ const _LegacyAgentController = async (req, res, next, initializeClient, addTitle
// Save the message if needed
if (client.savedMessageIds && !client.savedMessageIds.has(messageId)) {
await saveMessage(
- req,
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{ ...finalResponse, user: userId },
{ context: 'api/server/controllers/agents/request.js - response end' },
);
@@ -690,9 +706,15 @@ const _LegacyAgentController = async (req, res, next, initializeClient, addTitle
// Save user message if needed
if (!client.skipSaveUserMessage) {
- await saveMessage(req, userMessage, {
- context: "api/server/controllers/agents/request.js - don't skip saving user message",
- });
+ await saveMessage(
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
+ userMessage,
+ { context: "api/server/controllers/agents/request.js - don't skip saving user message" },
+ );
}
// Add title if needed - extract minimal data
diff --git a/api/server/controllers/agents/responses.js b/api/server/controllers/agents/responses.js
index 30ccacdba8..de185f4c2b 100644
--- a/api/server/controllers/agents/responses.js
+++ b/api/server/controllers/agents/responses.js
@@ -36,10 +36,7 @@ const {
} = require('~/server/controllers/agents/callbacks');
const { loadAgentTools, loadToolsForExecution } = require('~/server/services/ToolService');
const { findAccessibleResources } = require('~/server/services/PermissionService');
-const { getConvoFiles, saveConvo, getConvo } = require('~/models/Conversation');
-const { spendTokens, spendStructuredTokens } = require('~/models/spendTokens');
const { getMultiplier, getCacheMultiplier } = require('~/models/tx');
-const { getAgent, getAgents } = require('~/models/Agent');
const db = require('~/models');
/** @type {import('@librechat/api').AppConfig | null} */
@@ -214,8 +211,12 @@ async function saveResponseOutput(req, conversationId, responseId, response, age
* @returns {Promise<void>}
*/
async function saveConversation(req, conversationId, agentId, agent) {
- await saveConvo(
- req,
+ await db.saveConvo(
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{
conversationId,
endpoint: EModelEndpoint.agents,
@@ -279,7 +280,7 @@ const createResponse = async (req, res) => {
const isStreaming = request.stream === true;
// Look up the agent
- const agent = await getAgent({ id: agentId });
+ const agent = await db.getAgent({ id: agentId });
if (!agent) {
return sendResponsesErrorResponse(
res,
@@ -355,7 +356,7 @@ const createResponse = async (req, res) => {
isInitialAgent: true,
},
{
- getConvoFiles,
+ getConvoFiles: db.getConvoFiles,
getFiles: db.getFiles,
getUserKey: db.getUserKey,
getMessages: db.getMessages,
@@ -525,8 +526,8 @@ const createResponse = async (req, res) => {
const transactionsConfig = getTransactionsConfig(req.config);
recordCollectedUsage(
{
- spendTokens,
- spendStructuredTokens,
+ spendTokens: db.spendTokens,
+ spendStructuredTokens: db.spendStructuredTokens,
pricing: { getMultiplier, getCacheMultiplier },
bulkWriteOps: { insertMany: db.bulkInsertTransactions, updateBalance: db.updateBalance },
},
@@ -680,8 +681,8 @@ const createResponse = async (req, res) => {
const transactionsConfig = getTransactionsConfig(req.config);
recordCollectedUsage(
{
- spendTokens,
- spendStructuredTokens,
+ spendTokens: db.spendTokens,
+ spendStructuredTokens: db.spendStructuredTokens,
pricing: { getMultiplier, getCacheMultiplier },
bulkWriteOps: { insertMany: db.bulkInsertTransactions, updateBalance: db.updateBalance },
},
@@ -782,7 +783,7 @@ const listModels = async (req, res) => {
// Get the accessible agents
let agents = [];
if (accessibleAgentIds.length > 0) {
- agents = await getAgents({ _id: { $in: accessibleAgentIds } });
+ agents = await db.getAgents({ _id: { $in: accessibleAgentIds } });
}
// Convert to models format
@@ -832,7 +833,7 @@ const getResponse = async (req, res) => {
// The responseId could be either the response ID or the conversation ID
// Try to find a conversation with this ID
- const conversation = await getConvo(userId, responseId);
+ const conversation = await db.getConvo(userId, responseId);
if (!conversation) {
return sendResponsesErrorResponse(
diff --git a/api/server/controllers/agents/v1.js b/api/server/controllers/agents/v1.js
index 899b561352..40d80d571f 100644
--- a/api/server/controllers/agents/v1.js
+++ b/api/server/controllers/agents/v1.js
@@ -25,15 +25,6 @@ const {
actionDelimiter,
removeNullishValues,
} = require('librechat-data-provider');
-const {
- getListAgentsByAccess,
- countPromotedAgents,
- revertAgentVersion,
- createAgent,
- updateAgent,
- deleteAgent,
- getAgent,
-} = require('~/models/Agent');
const {
findPubliclyAccessibleResources,
getResourcePermissionsMap,
@@ -42,15 +33,14 @@ const {
grantPermission,
} = require('~/server/services/PermissionService');
const { getStrategyFunctions } = require('~/server/services/Files/strategies');
-const { getCategoriesWithCounts, deleteFileByFilter } = require('~/models');
const { resizeAvatar } = require('~/server/services/Files/images/avatar');
const { getFileStrategy } = require('~/server/utils/getFileStrategy');
const { refreshS3Url } = require('~/server/services/Files/S3/crud');
const { filterFile } = require('~/server/services/Files/process');
-const { updateAction, getActions } = require('~/models/Action');
const { getCachedTools } = require('~/server/services/Config');
const { getMCPServersRegistry } = require('~/config');
const { getLogStores } = require('~/cache');
+const db = require('~/models');
const systemTools = {
[Tools.execute_code]: true,
@@ -207,7 +197,7 @@ const createAgentHandler = async (req, res) => {
const availableTools = (await getCachedTools()) ?? {};
agentData.tools = await filterAuthorizedTools({ tools, userId, availableTools });
- const agent = await createAgent(agentData);
+ const agent = await db.createAgent(agentData);
try {
await Promise.all([
@@ -267,7 +257,7 @@ const getAgentHandler = async (req, res, expandProperties = false) => {
// Permissions are validated by middleware before calling this function
// Simply load the agent by ID
- const agent = await getAgent({ id });
+ const agent = await db.getAgent({ id });
if (!agent) {
return res.status(404).json({ error: 'Agent not found' });
@@ -366,7 +356,7 @@ const updateAgentHandler = async (req, res) => {
// Convert OCR to context in incoming updateData
convertOcrToContextInPlace(updateData);
- const existingAgent = await getAgent({ id });
+ const existingAgent = await db.getAgent({ id });
if (!existingAgent) {
return res.status(404).json({ error: 'Agent not found' });
@@ -403,7 +393,7 @@ const updateAgentHandler = async (req, res) => {
let updatedAgent =
Object.keys(updateData).length > 0
- ? await updateAgent({ id }, updateData, {
+ ? await db.updateAgent({ id }, updateData, {
updatingUserId: req.user.id,
})
: existingAgent;
@@ -453,7 +443,7 @@ const duplicateAgentHandler = async (req, res) => {
const sensitiveFields = ['api_key', 'oauth_client_id', 'oauth_client_secret'];
try {
- const agent = await getAgent({ id });
+ const agent = await db.getAgent({ id });
if (!agent) {
return res.status(404).json({
error: 'Agent not found',
@@ -501,7 +491,7 @@ const duplicateAgentHandler = async (req, res) => {
});
const newActionsList = [];
- const originalActions = (await getActions({ agent_id: id }, true)) ?? [];
+ const originalActions = (await db.getActions({ agent_id: id }, true)) ?? [];
const promises = [];
/**
@@ -520,7 +510,7 @@ const duplicateAgentHandler = async (req, res) => {
delete filteredMetadata[field];
}
- const newAction = await updateAction(
+ const newAction = await db.updateAction(
{ action_id: newActionId, agent_id: newAgentId },
{
metadata: filteredMetadata,
@@ -554,7 +544,7 @@ const duplicateAgentHandler = async (req, res) => {
});
}
- const newAgent = await createAgent(newAgentData);
+ const newAgent = await db.createAgent(newAgentData);
try {
await Promise.all([
@@ -607,11 +597,11 @@ const duplicateAgentHandler = async (req, res) => {
const deleteAgentHandler = async (req, res) => {
try {
const id = req.params.id;
- const agent = await getAgent({ id });
+ const agent = await db.getAgent({ id });
if (!agent) {
return res.status(404).json({ error: 'Agent not found' });
}
- await deleteAgent({ id });
+ await db.deleteAgent({ id });
return res.json({ message: 'Agent deleted' });
} catch (error) {
logger.error('[/Agents/:id] Error deleting Agent', error);
@@ -686,7 +676,7 @@ const getListAgentsHandler = async (req, res) => {
cachedRefresh != null && typeof cachedRefresh === 'object' && cachedRefresh.urlCache != null;
if (!isValidCachedRefresh) {
try {
- const fullList = await getListAgentsByAccess({
+ const fullList = await db.getListAgentsByAccess({
accessibleIds,
otherParams: {},
limit: MAX_AVATAR_REFRESH_AGENTS,
@@ -696,7 +686,7 @@ const getListAgentsHandler = async (req, res) => {
agents: fullList?.data ?? [],
userId,
refreshS3Url,
- updateAgent,
+ updateAgent: db.updateAgent,
});
cachedRefresh = { urlCache };
await cache.set(refreshKey, cachedRefresh, Time.THIRTY_MINUTES);
@@ -708,7 +698,7 @@ const getListAgentsHandler = async (req, res) => {
}
// Use the new ACL-aware function
- const data = await getListAgentsByAccess({
+ const data = await db.getListAgentsByAccess({
accessibleIds,
otherParams: filter,
limit,
@@ -773,7 +763,7 @@ const uploadAgentAvatarHandler = async (req, res) => {
return res.status(400).json({ message: 'Agent ID is required' });
}
- const existingAgent = await getAgent({ id: agent_id });
+ const existingAgent = await db.getAgent({ id: agent_id });
if (!existingAgent) {
return res.status(404).json({ error: 'Agent not found' });
@@ -805,7 +795,7 @@ const uploadAgentAvatarHandler = async (req, res) => {
const { deleteFile } = getStrategyFunctions(_avatar.source);
try {
await deleteFile(req, { filepath: _avatar.filepath });
- await deleteFileByFilter({ user: req.user.id, filepath: _avatar.filepath });
+ await db.deleteFileByFilter({ user: req.user.id, filepath: _avatar.filepath });
} catch (error) {
logger.error('[/:agent_id/avatar] Error deleting old avatar', error);
}
@@ -818,7 +808,7 @@ const uploadAgentAvatarHandler = async (req, res) => {
},
};
- const updatedAgent = await updateAgent({ id: agent_id }, data, {
+ const updatedAgent = await db.updateAgent({ id: agent_id }, data, {
updatingUserId: req.user.id,
});
@@ -874,7 +864,7 @@ const revertAgentVersionHandler = async (req, res) => {
return res.status(400).json({ error: 'version_index is required' });
}
- const existingAgent = await getAgent({ id });
+ const existingAgent = await db.getAgent({ id });
if (!existingAgent) {
return res.status(404).json({ error: 'Agent not found' });
@@ -882,7 +872,7 @@ const revertAgentVersionHandler = async (req, res) => {
// Permissions are enforced via route middleware (ACL EDIT)
- let updatedAgent = await revertAgentVersion({ id }, version_index);
+ let updatedAgent = await db.revertAgentVersion({ id }, version_index);
if (updatedAgent.tools?.length) {
const availableTools = (await getCachedTools()) ?? {};
@@ -893,7 +883,7 @@ const revertAgentVersionHandler = async (req, res) => {
existingTools: updatedAgent.tools,
});
if (filteredTools.length !== updatedAgent.tools.length) {
- updatedAgent = await updateAgent(
+ updatedAgent = await db.updateAgent(
{ id },
{ tools: filteredTools },
{ updatingUserId: req.user.id },
@@ -923,8 +913,8 @@ const revertAgentVersionHandler = async (req, res) => {
*/
const getAgentCategories = async (_req, res) => {
try {
- const categories = await getCategoriesWithCounts();
- const promotedCount = await countPromotedAgents();
+ const categories = await db.getCategoriesWithCounts();
+ const promotedCount = await db.countPromotedAgents();
const formattedCategories = categories.map((category) => ({
value: category.value,
label: category.label,
diff --git a/api/server/controllers/agents/v1.spec.js b/api/server/controllers/agents/v1.spec.js
index 56bb90675a..9a8dd0a50a 100644
--- a/api/server/controllers/agents/v1.spec.js
+++ b/api/server/controllers/agents/v1.spec.js
@@ -30,15 +30,6 @@ jest.mock('~/server/services/Files/process', () => ({
filterFile: jest.fn(),
}));
-jest.mock('~/models/Action', () => ({
- updateAction: jest.fn(),
- getActions: jest.fn().mockResolvedValue([]),
-}));
-
-jest.mock('~/models/File', () => ({
- deleteFileByFilter: jest.fn(),
-}));
-
jest.mock('~/server/services/PermissionService', () => ({
findAccessibleResources: jest.fn().mockResolvedValue([]),
findPubliclyAccessibleResources: jest.fn().mockResolvedValue([]),
@@ -47,9 +38,18 @@ jest.mock('~/server/services/PermissionService', () => ({
hasPublicPermission: jest.fn().mockResolvedValue(false),
}));
-jest.mock('~/models', () => ({
- getCategoriesWithCounts: jest.fn(),
-}));
+jest.mock('~/models', () => {
+ const mongoose = require('mongoose');
+ const { createMethods } = require('@librechat/data-schemas');
+ const methods = createMethods(mongoose, {
+ removeAllPermissions: jest.fn().mockResolvedValue(undefined),
+ });
+ return {
+ ...methods,
+ getCategoriesWithCounts: jest.fn(),
+ deleteFileByFilter: jest.fn(),
+ };
+});
// Mock cache for S3 avatar refresh tests
const mockCache = {
diff --git a/api/server/controllers/assistants/chatV1.js b/api/server/controllers/assistants/chatV1.js
index 804594d0bf..e4a20c2a5e 100644
--- a/api/server/controllers/assistants/chatV1.js
+++ b/api/server/controllers/assistants/chatV1.js
@@ -1,7 +1,13 @@
const { v4 } = require('uuid');
const { sleep } = require('@librechat/agents');
const { logger } = require('@librechat/data-schemas');
-const { sendEvent, getBalanceConfig, getModelMaxTokens, countTokens } = require('@librechat/api');
+const {
+ sendEvent,
+ countTokens,
+ checkBalance,
+ getBalanceConfig,
+ getModelMaxTokens,
+} = require('@librechat/api');
const {
Time,
Constants,
@@ -31,10 +37,14 @@ const { createRun, StreamRunManager } = require('~/server/services/Runs');
const { addTitle } = require('~/server/services/Endpoints/assistants');
const { createRunBody } = require('~/server/services/createRunBody');
const { sendResponse } = require('~/server/middleware/error');
-const { getTransactions } = require('~/models/Transaction');
-const { checkBalance } = require('~/models/balanceMethods');
-const { getConvo } = require('~/models/Conversation');
-const getLogStores = require('~/cache/getLogStores');
+const {
+ createAutoRefillTransaction,
+ findBalanceByUser,
+ getTransactions,
+ getMultiplier,
+ getConvo,
+} = require('~/models');
+const { logViolation, getLogStores } = require('~/cache');
const { getOpenAIClient } = require('./helpers');
/**
@@ -275,16 +285,19 @@ const chatV1 = async (req, res) => {
// Count tokens up to the current context window
promptTokens = Math.min(promptTokens, getModelMaxTokens(model));
- await checkBalance({
- req,
- res,
- txData: {
- model,
- user: req.user.id,
- tokenType: 'prompt',
- amount: promptTokens,
+ await checkBalance(
+ {
+ req,
+ res,
+ txData: {
+ model,
+ user: req.user.id,
+ tokenType: 'prompt',
+ amount: promptTokens,
+ },
},
- });
+ { findBalanceByUser, getMultiplier, createAutoRefillTransaction, logViolation },
+ );
};
const { openai: _openai } = await getOpenAIClient({
diff --git a/api/server/controllers/assistants/chatV2.js b/api/server/controllers/assistants/chatV2.js
index 414681d6dc..559d9d8953 100644
--- a/api/server/controllers/assistants/chatV2.js
+++ b/api/server/controllers/assistants/chatV2.js
@@ -1,7 +1,13 @@
const { v4 } = require('uuid');
const { sleep } = require('@librechat/agents');
const { logger } = require('@librechat/data-schemas');
-const { sendEvent, getBalanceConfig, getModelMaxTokens, countTokens } = require('@librechat/api');
+const {
+ sendEvent,
+ countTokens,
+ checkBalance,
+ getBalanceConfig,
+ getModelMaxTokens,
+} = require('@librechat/api');
const {
Time,
Constants,
@@ -26,10 +32,14 @@ const validateAuthor = require('~/server/middleware/assistants/validateAuthor');
const { createRun, StreamRunManager } = require('~/server/services/Runs');
const { addTitle } = require('~/server/services/Endpoints/assistants');
const { createRunBody } = require('~/server/services/createRunBody');
-const { getTransactions } = require('~/models/Transaction');
-const { checkBalance } = require('~/models/balanceMethods');
-const { getConvo } = require('~/models/Conversation');
-const getLogStores = require('~/cache/getLogStores');
+const {
+ getConvo,
+ getMultiplier,
+ getTransactions,
+ findBalanceByUser,
+ createAutoRefillTransaction,
+} = require('~/models');
+const { logViolation, getLogStores } = require('~/cache');
const { getOpenAIClient } = require('./helpers');
/**
@@ -148,16 +158,19 @@ const chatV2 = async (req, res) => {
// Count tokens up to the current context window
promptTokens = Math.min(promptTokens, getModelMaxTokens(model));
- await checkBalance({
- req,
- res,
- txData: {
- model,
- user: req.user.id,
- tokenType: 'prompt',
- amount: promptTokens,
+ await checkBalance(
+ {
+ req,
+ res,
+ txData: {
+ model,
+ user: req.user.id,
+ tokenType: 'prompt',
+ amount: promptTokens,
+ },
},
- });
+ { findBalanceByUser, getMultiplier, createAutoRefillTransaction, logViolation },
+ );
};
const { openai: _openai } = await getOpenAIClient({
diff --git a/api/server/controllers/assistants/errors.js b/api/server/controllers/assistants/errors.js
index 1ae12ea3d5..f8dcf39f2b 100644
--- a/api/server/controllers/assistants/errors.js
+++ b/api/server/controllers/assistants/errors.js
@@ -3,8 +3,8 @@ const { logger } = require('@librechat/data-schemas');
const { CacheKeys, ViolationTypes, ContentTypes } = require('librechat-data-provider');
const { recordUsage, checkMessageGaps } = require('~/server/services/Threads');
const { sendResponse } = require('~/server/middleware/error');
-const { getConvo } = require('~/models/Conversation');
const getLogStores = require('~/cache/getLogStores');
+const { getConvo } = require('~/models');
/**
* @typedef {Object} ErrorHandlerContext
diff --git a/api/server/controllers/assistants/v1.js b/api/server/controllers/assistants/v1.js
index 5d13d30334..c441b7ec59 100644
--- a/api/server/controllers/assistants/v1.js
+++ b/api/server/controllers/assistants/v1.js
@@ -1,15 +1,14 @@
const fs = require('fs').promises;
const { logger } = require('@librechat/data-schemas');
const { FileContext } = require('librechat-data-provider');
+const { deleteFileByFilter, updateAssistantDoc, getAssistants } = require('~/models');
const { uploadImageBuffer, filterFile } = require('~/server/services/Files/process');
const validateAuthor = require('~/server/middleware/assistants/validateAuthor');
const { getStrategyFunctions } = require('~/server/services/Files/strategies');
const { deleteAssistantActions } = require('~/server/services/ActionService');
-const { updateAssistantDoc, getAssistants } = require('~/models/Assistant');
const { getOpenAIClient, fetchAssistants } = require('./helpers');
const { getCachedTools } = require('~/server/services/Config');
const { manifestToolMap } = require('~/app/clients/tools');
-const { deleteFileByFilter } = require('~/models');
/**
* Create an assistant.
diff --git a/api/server/controllers/assistants/v2.js b/api/server/controllers/assistants/v2.js
index b9c5cd709f..cc0e03916d 100644
--- a/api/server/controllers/assistants/v2.js
+++ b/api/server/controllers/assistants/v2.js
@@ -3,8 +3,8 @@ const { ToolCallTypes } = require('librechat-data-provider');
const validateAuthor = require('~/server/middleware/assistants/validateAuthor');
const { validateAndUpdateTool } = require('~/server/services/ActionService');
const { getCachedTools } = require('~/server/services/Config');
-const { updateAssistantDoc } = require('~/models/Assistant');
const { manifestToolMap } = require('~/app/clients/tools');
+const { updateAssistantDoc } = require('~/models');
const { getOpenAIClient } = require('./helpers');
/**
diff --git a/api/server/controllers/tools.js b/api/server/controllers/tools.js
index 14a757e2bc..1df11b1059 100644
--- a/api/server/controllers/tools.js
+++ b/api/server/controllers/tools.js
@@ -9,13 +9,11 @@ const {
ToolCallTypes,
PermissionTypes,
} = require('librechat-data-provider');
+const { getRoleByName, createToolCall, getToolCallsByConvo, getMessage } = require('~/models');
const { processFileURL, uploadImageBuffer } = require('~/server/services/Files/process');
const { processCodeOutput } = require('~/server/services/Files/Code/process');
-const { createToolCall, getToolCallsByConvo } = require('~/models/ToolCall');
const { loadAuthValues } = require('~/server/services/Tools/credentials');
const { loadTools } = require('~/app/clients/tools/util');
-const { getRoleByName } = require('~/models/Role');
-const { getMessage } = require('~/models/Message');
const fieldsMap = {
[Tools.execute_code]: [EnvVar.CODE_API_KEY],
diff --git a/api/server/experimental.js b/api/server/experimental.js
index 7b60ad7fd2..8982b69afb 100644
--- a/api/server/experimental.js
+++ b/api/server/experimental.js
@@ -24,14 +24,14 @@ const { connectDb, indexSync } = require('~/db');
const initializeOAuthReconnectManager = require('./services/initializeOAuthReconnectManager');
const createValidateImageRequest = require('./middleware/validateImageRequest');
const { jwtLogin, ldapLogin, passportLogin } = require('~/strategies');
-const { updateInterfacePermissions } = require('~/models/interface');
+const { updateInterfacePermissions: updateInterfacePerms } = require('@librechat/api');
+const { getRoleByName, updateAccessPermissions, seedDatabase } = require('~/models');
const { checkMigrations } = require('./services/start/migration');
const initializeMCPs = require('./services/initializeMCPs');
const configureSocialLogins = require('./socialLogins');
const { getAppConfig } = require('./services/Config');
const staticCache = require('./utils/staticCache');
const noIndex = require('./middleware/noIndex');
-const { seedDatabase } = require('~/models');
const routes = require('./routes');
const { PORT, HOST, ALLOW_SOCIAL_LOGIN, DISABLE_COMPRESSION, TRUST_PROXY } = process.env ?? {};
@@ -222,7 +222,7 @@ if (cluster.isMaster) {
const appConfig = await getAppConfig();
initializeFileStorage(appConfig);
await performStartupChecks(appConfig);
- await updateInterfacePermissions(appConfig);
+ await updateInterfacePerms({ appConfig, getRoleByName, updateAccessPermissions });
/** Load index.html for SPA serving */
const indexPath = path.join(appConfig.paths.dist, 'index.html');
diff --git a/api/server/index.js b/api/server/index.js
index f034f10236..6af829eab8 100644
--- a/api/server/index.js
+++ b/api/server/index.js
@@ -25,14 +25,14 @@ const { connectDb, indexSync } = require('~/db');
const initializeOAuthReconnectManager = require('./services/initializeOAuthReconnectManager');
const createValidateImageRequest = require('./middleware/validateImageRequest');
const { jwtLogin, ldapLogin, passportLogin } = require('~/strategies');
-const { updateInterfacePermissions } = require('~/models/interface');
+const { updateInterfacePermissions: updateInterfacePerms } = require('@librechat/api');
+const { getRoleByName, updateAccessPermissions, seedDatabase } = require('~/models');
const { checkMigrations } = require('./services/start/migration');
const initializeMCPs = require('./services/initializeMCPs');
const configureSocialLogins = require('./socialLogins');
const { getAppConfig } = require('./services/Config');
const staticCache = require('./utils/staticCache');
const noIndex = require('./middleware/noIndex');
-const { seedDatabase } = require('~/models');
const routes = require('./routes');
const { PORT, HOST, ALLOW_SOCIAL_LOGIN, DISABLE_COMPRESSION, TRUST_PROXY } = process.env ?? {};
@@ -62,7 +62,7 @@ const startServer = async () => {
const appConfig = await getAppConfig();
initializeFileStorage(appConfig);
await performStartupChecks(appConfig);
- await updateInterfacePermissions(appConfig);
+ await updateInterfacePerms({ appConfig, getRoleByName, updateAccessPermissions });
const indexPath = path.join(appConfig.paths.dist, 'index.html');
let indexHTML = fs.readFileSync(indexPath, 'utf8');
diff --git a/api/server/middleware/abortMiddleware.js b/api/server/middleware/abortMiddleware.js
index d39b0104a8..624ace7f9f 100644
--- a/api/server/middleware/abortMiddleware.js
+++ b/api/server/middleware/abortMiddleware.js
@@ -1,4 +1,5 @@
const { logger } = require('@librechat/data-schemas');
+const { isAssistantsEndpoint, ErrorTypes } = require('librechat-data-provider');
const {
isEnabled,
sendEvent,
@@ -9,7 +10,6 @@ const {
} = require('@librechat/api');
const { isAssistantsEndpoint, ErrorTypes } = require('librechat-data-provider');
const { saveMessage, getConvo, updateBalance, bulkInsertTransactions } = require('~/models');
-const { spendTokens, spendStructuredTokens } = require('~/models/spendTokens');
const { truncateText, smartTruncateText } = require('~/app/clients/prompts');
const { getMultiplier, getCacheMultiplier } = require('~/models/tx');
const clearPendingReq = require('~/cache/clearPendingReq');
@@ -130,7 +130,11 @@ async function abortMessage(req, res) {
}
await saveMessage(
- req,
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{ ...responseMessage, user: userId },
{ context: 'api/server/middleware/abortMiddleware.js' },
);
diff --git a/api/server/middleware/abortMiddleware.spec.js b/api/server/middleware/abortMiddleware.spec.js
index 795814a928..c9c0d5cc60 100644
--- a/api/server/middleware/abortMiddleware.spec.js
+++ b/api/server/middleware/abortMiddleware.spec.js
@@ -20,15 +20,7 @@ const mockRecordCollectedUsage = jest
const mockGetMultiplier = jest.fn().mockReturnValue(1);
const mockGetCacheMultiplier = jest.fn().mockReturnValue(null);
-jest.mock('~/models/spendTokens', () => ({
- spendTokens: (...args) => mockSpendTokens(...args),
- spendStructuredTokens: (...args) => mockSpendStructuredTokens(...args),
-}));
-jest.mock('~/models/tx', () => ({
- getMultiplier: mockGetMultiplier,
- getCacheMultiplier: mockGetCacheMultiplier,
-}));
jest.mock('@librechat/data-schemas', () => ({
logger: {
diff --git a/api/server/middleware/abortRun.js b/api/server/middleware/abortRun.js
index 44375f5024..318693fe15 100644
--- a/api/server/middleware/abortRun.js
+++ b/api/server/middleware/abortRun.js
@@ -3,8 +3,7 @@ const { logger } = require('@librechat/data-schemas');
const { CacheKeys, RunStatus, isUUID } = require('librechat-data-provider');
const { initializeClient } = require('~/server/services/Endpoints/assistants');
const { checkMessageGaps, recordUsage } = require('~/server/services/Threads');
-const { deleteMessages } = require('~/models/Message');
-const { getConvo } = require('~/models/Conversation');
+const { deleteMessages, getConvo } = require('~/models');
const getLogStores = require('~/cache/getLogStores');
const three_minutes = 1000 * 60 * 3;
diff --git a/api/server/middleware/accessResources/canAccessAgentFromBody.js b/api/server/middleware/accessResources/canAccessAgentFromBody.js
index 572a86f5e5..5ade76bb77 100644
--- a/api/server/middleware/accessResources/canAccessAgentFromBody.js
+++ b/api/server/middleware/accessResources/canAccessAgentFromBody.js
@@ -10,8 +10,9 @@ const {
} = require('librechat-data-provider');
const { checkPermission } = require('~/server/services/PermissionService');
const { canAccessResource } = require('./canAccessResource');
-const { getRoleByName } = require('~/models/Role');
-const { getAgent } = require('~/models/Agent');
+const db = require('~/models');
+
+const { getRoleByName, getAgent } = db;
/**
* Resolves custom agent ID (e.g., "agent_abc123") to a MongoDB document.
diff --git a/api/server/middleware/accessResources/canAccessAgentResource.js b/api/server/middleware/accessResources/canAccessAgentResource.js
index 62d9f248c0..4c00ab4982 100644
--- a/api/server/middleware/accessResources/canAccessAgentResource.js
+++ b/api/server/middleware/accessResources/canAccessAgentResource.js
@@ -1,6 +1,6 @@
const { ResourceType } = require('librechat-data-provider');
const { canAccessResource } = require('./canAccessResource');
-const { getAgent } = require('~/models/Agent');
+const { getAgent } = require('~/models');
/**
* Agent ID resolver function
diff --git a/api/server/middleware/accessResources/canAccessAgentResource.spec.js b/api/server/middleware/accessResources/canAccessAgentResource.spec.js
index 1106390e72..786636ee74 100644
--- a/api/server/middleware/accessResources/canAccessAgentResource.spec.js
+++ b/api/server/middleware/accessResources/canAccessAgentResource.spec.js
@@ -3,7 +3,7 @@ const { ResourceType, PrincipalType, PrincipalModel } = require('librechat-data-
const { MongoMemoryServer } = require('mongodb-memory-server');
const { canAccessAgentResource } = require('./canAccessAgentResource');
const { User, Role, AclEntry } = require('~/db/models');
-const { createAgent } = require('~/models/Agent');
+const { createAgent } = require('~/models');
describe('canAccessAgentResource middleware', () => {
let mongoServer;
@@ -373,7 +373,7 @@ describe('canAccessAgentResource middleware', () => {
jest.clearAllMocks();
// Update the agent
- const { updateAgent } = require('~/models/Agent');
+ const { updateAgent } = require('~/models');
await updateAgent({ id: agentId }, { description: 'Updated description' });
// Test edit access
diff --git a/api/server/middleware/accessResources/canAccessPromptGroupResource.js b/api/server/middleware/accessResources/canAccessPromptGroupResource.js
index 90aa280772..9da1994a77 100644
--- a/api/server/middleware/accessResources/canAccessPromptGroupResource.js
+++ b/api/server/middleware/accessResources/canAccessPromptGroupResource.js
@@ -1,6 +1,6 @@
const { ResourceType } = require('librechat-data-provider');
const { canAccessResource } = require('./canAccessResource');
-const { getPromptGroup } = require('~/models/Prompt');
+const { getPromptGroup } = require('~/models');
/**
* PromptGroup ID resolver function
diff --git a/api/server/middleware/accessResources/canAccessPromptViaGroup.js b/api/server/middleware/accessResources/canAccessPromptViaGroup.js
index 0bb0a804a9..534db3d6c6 100644
--- a/api/server/middleware/accessResources/canAccessPromptViaGroup.js
+++ b/api/server/middleware/accessResources/canAccessPromptViaGroup.js
@@ -1,6 +1,6 @@
const { ResourceType } = require('librechat-data-provider');
const { canAccessResource } = require('./canAccessResource');
-const { getPrompt } = require('~/models/Prompt');
+const { getPrompt } = require('~/models');
/**
* Prompt to PromptGroup ID resolver function
diff --git a/api/server/middleware/accessResources/fileAccess.js b/api/server/middleware/accessResources/fileAccess.js
index 25d41e7c02..0f77a61175 100644
--- a/api/server/middleware/accessResources/fileAccess.js
+++ b/api/server/middleware/accessResources/fileAccess.js
@@ -1,8 +1,7 @@
const { logger } = require('@librechat/data-schemas');
const { PermissionBits, hasPermissions, ResourceType } = require('librechat-data-provider');
const { getEffectivePermissions } = require('~/server/services/PermissionService');
-const { getAgents } = require('~/models/Agent');
-const { getFiles } = require('~/models');
+const { getAgents, getFiles } = require('~/models');
/**
* Checks if user has access to a file through agent permissions
diff --git a/api/server/middleware/accessResources/fileAccess.spec.js b/api/server/middleware/accessResources/fileAccess.spec.js
index cc0d57ac48..72896b0629 100644
--- a/api/server/middleware/accessResources/fileAccess.spec.js
+++ b/api/server/middleware/accessResources/fileAccess.spec.js
@@ -3,8 +3,7 @@ const { ResourceType, PrincipalType, PrincipalModel } = require('librechat-data-
const { MongoMemoryServer } = require('mongodb-memory-server');
const { fileAccess } = require('./fileAccess');
const { User, Role, AclEntry } = require('~/db/models');
-const { createAgent } = require('~/models/Agent');
-const { createFile } = require('~/models');
+const { createAgent, createFile } = require('~/models');
describe('fileAccess middleware', () => {
let mongoServer;
diff --git a/api/server/middleware/assistants/validateAuthor.js b/api/server/middleware/assistants/validateAuthor.js
index 03936444e0..6c15704251 100644
--- a/api/server/middleware/assistants/validateAuthor.js
+++ b/api/server/middleware/assistants/validateAuthor.js
@@ -1,5 +1,5 @@
const { SystemRoles } = require('librechat-data-provider');
-const { getAssistant } = require('~/models/Assistant');
+const { getAssistant } = require('~/models');
/**
* Checks if the assistant is supported or excluded
diff --git a/api/server/middleware/checkInviteUser.js b/api/server/middleware/checkInviteUser.js
index 42e1faba5b..22f2824ffc 100644
--- a/api/server/middleware/checkInviteUser.js
+++ b/api/server/middleware/checkInviteUser.js
@@ -1,5 +1,8 @@
-const { getInvite } = require('~/models/inviteUser');
-const { deleteTokens } = require('~/models');
+const { getInvite: getInviteFn } = require('@librechat/api');
+const { createToken, findToken, deleteTokens } = require('~/models');
+
+const getInvite = (encodedToken, email) =>
+ getInviteFn(encodedToken, email, { createToken, findToken });
async function checkInviteUser(req, res, next) {
const token = req.body.token;
diff --git a/api/server/middleware/checkPeoplePickerAccess.js b/api/server/middleware/checkPeoplePickerAccess.js
index af2154dbba..50f137285e 100644
--- a/api/server/middleware/checkPeoplePickerAccess.js
+++ b/api/server/middleware/checkPeoplePickerAccess.js
@@ -1,6 +1,6 @@
const { logger } = require('@librechat/data-schemas');
const { PrincipalType, PermissionTypes, Permissions } = require('librechat-data-provider');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
const VALID_PRINCIPAL_TYPES = new Set([
PrincipalType.USER,
diff --git a/api/server/middleware/checkPeoplePickerAccess.spec.js b/api/server/middleware/checkPeoplePickerAccess.spec.js
index 9a229610de..c394bbae65 100644
--- a/api/server/middleware/checkPeoplePickerAccess.spec.js
+++ b/api/server/middleware/checkPeoplePickerAccess.spec.js
@@ -1,9 +1,9 @@
const { logger } = require('@librechat/data-schemas');
const { PrincipalType, PermissionTypes, Permissions } = require('librechat-data-provider');
const { checkPeoplePickerAccess } = require('./checkPeoplePickerAccess');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
-jest.mock('~/models/Role');
+jest.mock('~/models');
jest.mock('@librechat/data-schemas', () => ({
...jest.requireActual('@librechat/data-schemas'),
logger: {
diff --git a/api/server/middleware/checkSharePublicAccess.js b/api/server/middleware/checkSharePublicAccess.js
index 0e95b9f6f8..c7b65a077e 100644
--- a/api/server/middleware/checkSharePublicAccess.js
+++ b/api/server/middleware/checkSharePublicAccess.js
@@ -1,6 +1,6 @@
const { logger } = require('@librechat/data-schemas');
const { ResourceType, PermissionTypes, Permissions } = require('librechat-data-provider');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
/**
* Maps resource types to their corresponding permission types
diff --git a/api/server/middleware/checkSharePublicAccess.spec.js b/api/server/middleware/checkSharePublicAccess.spec.js
index c73e71693b..605de2049e 100644
--- a/api/server/middleware/checkSharePublicAccess.spec.js
+++ b/api/server/middleware/checkSharePublicAccess.spec.js
@@ -1,8 +1,8 @@
const { ResourceType, PermissionTypes, Permissions } = require('librechat-data-provider');
const { checkSharePublicAccess } = require('./checkSharePublicAccess');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
-jest.mock('~/models/Role');
+jest.mock('~/models');
describe('checkSharePublicAccess middleware', () => {
let mockReq;
diff --git a/api/server/middleware/denyRequest.js b/api/server/middleware/denyRequest.js
index 20360519cf..86054d0a23 100644
--- a/api/server/middleware/denyRequest.js
+++ b/api/server/middleware/denyRequest.js
@@ -43,7 +43,11 @@ const denyRequest = async (req, res, errorMessage) => {
if (shouldSaveMessage) {
await saveMessage(
- req,
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{ ...userMessage, user: req.user.id },
{ context: `api/server/middleware/denyRequest.js - ${responseText}` },
);
diff --git a/api/server/middleware/error.js b/api/server/middleware/error.js
index fef7e60ef7..5fa3562c30 100644
--- a/api/server/middleware/error.js
+++ b/api/server/middleware/error.js
@@ -2,8 +2,7 @@ const crypto = require('crypto');
const { logger } = require('@librechat/data-schemas');
const { parseConvo } = require('librechat-data-provider');
const { sendEvent, handleError, sanitizeMessageForTransmit } = require('@librechat/api');
-const { saveMessage, getMessages } = require('~/models/Message');
-const { getConvo } = require('~/models/Conversation');
+const { saveMessage, getMessages, getConvo } = require('~/models');
/**
* Processes an error with provided options, saves the error message and sends a corresponding SSE response
@@ -49,7 +48,11 @@ const sendError = async (req, res, options, callback) => {
if (shouldSaveMessage) {
await saveMessage(
- req,
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{ ...errorMessage, user },
{
context: 'api/server/utils/streamResponse.js - sendError',
diff --git a/api/server/middleware/roles/access.spec.js b/api/server/middleware/roles/access.spec.js
index 9de840819d..16fb6df138 100644
--- a/api/server/middleware/roles/access.spec.js
+++ b/api/server/middleware/roles/access.spec.js
@@ -2,7 +2,7 @@ const mongoose = require('mongoose');
const { MongoMemoryServer } = require('mongodb-memory-server');
const { checkAccess, generateCheckAccess } = require('@librechat/api');
const { PermissionTypes, Permissions } = require('librechat-data-provider');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
const { Role } = require('~/db/models');
// Mock the logger from @librechat/data-schemas
diff --git a/api/server/middleware/validate/convoAccess.js b/api/server/middleware/validate/convoAccess.js
index 127bfdc530..ef1eea8f37 100644
--- a/api/server/middleware/validate/convoAccess.js
+++ b/api/server/middleware/validate/convoAccess.js
@@ -1,8 +1,8 @@
const { isEnabled } = require('@librechat/api');
const { Constants, ViolationTypes, Time } = require('librechat-data-provider');
-const { searchConversation } = require('~/models/Conversation');
const denyRequest = require('~/server/middleware/denyRequest');
const { logViolation, getLogStores } = require('~/cache');
+const { searchConversation } = require('~/models');
const { USE_REDIS, CONVO_ACCESS_VIOLATION_SCORE: score = 0 } = process.env ?? {};
diff --git a/api/server/routes/__tests__/convos.spec.js b/api/server/routes/__tests__/convos.spec.js
index 3bdeac32db..23978f28e9 100644
--- a/api/server/routes/__tests__/convos.spec.js
+++ b/api/server/routes/__tests__/convos.spec.js
@@ -7,8 +7,6 @@ jest.mock('@librechat/agents', () => require(MOCKS).agents());
jest.mock('@librechat/api', () => require(MOCKS).api());
jest.mock('@librechat/data-schemas', () => require(MOCKS).dataSchemas());
jest.mock('librechat-data-provider', () => require(MOCKS).dataProvider());
-jest.mock('~/models/Conversation', () => require(MOCKS).conversationModel());
-jest.mock('~/models/ToolCall', () => require(MOCKS).toolCallModel());
jest.mock('~/models', () => require(MOCKS).sharedModels());
jest.mock('~/server/middleware/requireJwtAuth', () => require(MOCKS).requireJwtAuth());
jest.mock('~/server/middleware', () => require(MOCKS).middlewarePassthrough());
@@ -23,9 +21,13 @@ jest.mock('~/server/services/Endpoints/assistants', () => require(MOCKS).assista
describe('Convos Routes', () => {
let app;
let convosRouter;
- const { deleteAllSharedLinks, deleteConvoSharedLink } = require('~/models');
- const { deleteConvos, saveConvo } = require('~/models/Conversation');
- const { deleteToolCalls } = require('~/models/ToolCall');
+ const {
+ deleteAllSharedLinks,
+ deleteConvoSharedLink,
+ deleteToolCalls,
+ deleteConvos,
+ saveConvo,
+ } = require('~/models');
beforeAll(() => {
convosRouter = require('../convos');
@@ -435,7 +437,7 @@ describe('Convos Routes', () => {
expect(response.status).toBe(200);
expect(response.body).toEqual(mockArchivedConvo);
expect(saveConvo).toHaveBeenCalledWith(
- expect.objectContaining({ user: { id: 'test-user-123' } }),
+ expect.objectContaining({ userId: 'test-user-123' }),
{ conversationId: mockConversationId, isArchived: true },
{ context: `POST /api/convos/archive ${mockConversationId}` },
);
@@ -464,7 +466,7 @@ describe('Convos Routes', () => {
expect(response.status).toBe(200);
expect(response.body).toEqual(mockUnarchivedConvo);
expect(saveConvo).toHaveBeenCalledWith(
- expect.objectContaining({ user: { id: 'test-user-123' } }),
+ expect.objectContaining({ userId: 'test-user-123' }),
{ conversationId: mockConversationId, isArchived: false },
{ context: `POST /api/convos/archive ${mockConversationId}` },
);
diff --git a/api/server/routes/accessPermissions.test.js b/api/server/routes/accessPermissions.test.js
index 81c21c8667..ddbe702f15 100644
--- a/api/server/routes/accessPermissions.test.js
+++ b/api/server/routes/accessPermissions.test.js
@@ -5,7 +5,7 @@ const { v4: uuidv4 } = require('uuid');
const { createMethods } = require('@librechat/data-schemas');
const { MongoMemoryServer } = require('mongodb-memory-server');
const { ResourceType, PermissionBits } = require('librechat-data-provider');
-const { createAgent } = require('~/models/Agent');
+const { createAgent } = require('~/models');
/**
* Mock the PermissionsController to isolate route testing
diff --git a/api/server/routes/admin/auth.js b/api/server/routes/admin/auth.js
index 291b5eaaf8..e729f20940 100644
--- a/api/server/routes/admin/auth.js
+++ b/api/server/routes/admin/auth.js
@@ -11,15 +11,16 @@ const {
} = require('@librechat/api');
const { loginController } = require('~/server/controllers/auth/LoginController');
const { createOAuthHandler } = require('~/server/controllers/auth/oauth');
+const { findBalanceByUser, upsertBalanceFields } = require('~/models');
const { getAppConfig } = require('~/server/services/Config');
const getLogStores = require('~/cache/getLogStores');
const { getOpenIdConfig } = require('~/strategies');
const middleware = require('~/server/middleware');
-const { Balance } = require('~/db/models');
const setBalanceConfig = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const router = express.Router();
diff --git a/api/server/routes/agents/actions.js b/api/server/routes/agents/actions.js
index f3970bff22..b3b34f3f1c 100644
--- a/api/server/routes/agents/actions.js
+++ b/api/server/routes/agents/actions.js
@@ -18,17 +18,15 @@ const {
domainParser,
} = require('~/server/services/ActionService');
const { findAccessibleResources } = require('~/server/services/PermissionService');
-const { getAgent, updateAgent, getListAgentsByAccess } = require('~/models/Agent');
-const { updateAction, getActions, deleteAction } = require('~/models/Action');
+const db = require('~/models');
const { canAccessAgentResource } = require('~/server/middleware');
-const { getRoleByName } = require('~/models/Role');
const router = express.Router();
const checkAgentCreate = generateCheckAccess({
permissionType: PermissionTypes.AGENTS,
permissions: [Permissions.USE, Permissions.CREATE],
- getRoleByName,
+ getRoleByName: db.getRoleByName,
});
/**
@@ -47,13 +45,15 @@ router.get('/', async (req, res) => {
requiredPermissions: PermissionBits.EDIT,
});
- const agentsResponse = await getListAgentsByAccess({
+ const agentsResponse = await db.getListAgentsByAccess({
accessibleIds: editableAgentObjectIds,
});
const editableAgentIds = agentsResponse.data.map((agent) => agent.id);
const actions =
- editableAgentIds.length > 0 ? await getActions({ agent_id: { $in: editableAgentIds } }) : [];
+ editableAgentIds.length > 0
+ ? await db.getActions({ agent_id: { $in: editableAgentIds } })
+ : [];
res.json(actions);
} catch (error) {
@@ -135,9 +135,9 @@ router.post(
const initialPromises = [];
// Permissions already validated by middleware - load agent directly
- initialPromises.push(getAgent({ id: agent_id }));
+ initialPromises.push(db.getAgent({ id: agent_id }));
if (_action_id) {
- initialPromises.push(getActions({ action_id }, true));
+ initialPromises.push(db.getActions({ action_id }, true));
}
/** @type {[Agent, [Action|undefined]]} */
@@ -184,7 +184,7 @@ router.post(
.concat(functions.map((tool) => `${tool.function.name}${actionDelimiter}${encodedDomain}`));
// Force version update since actions are changing
- const updatedAgent = await updateAgent(
+ const updatedAgent = await db.updateAgent(
{ id: agent_id },
{ tools, actions },
{
@@ -201,7 +201,7 @@ router.post(
}
/** @type {[Action]} */
- const updatedAction = await updateAction({ action_id, agent_id }, actionUpdateData);
+ const updatedAction = await db.updateAction({ action_id, agent_id }, actionUpdateData);
const sensitiveFields = ['api_key', 'oauth_client_id', 'oauth_client_secret'];
for (let field of sensitiveFields) {
@@ -238,7 +238,7 @@ router.delete(
const { agent_id, action_id } = req.params;
// Permissions already validated by middleware - load agent directly
- const agent = await getAgent({ id: agent_id });
+ const agent = await db.getAgent({ id: agent_id });
if (!agent) {
return res.status(404).json({ message: 'Agent not found for deleting action' });
}
@@ -263,12 +263,12 @@ router.delete(
);
// Force version update since actions are being removed
- await updateAgent(
+ await db.updateAgent(
{ id: agent_id },
{ tools: updatedTools, actions: updatedActions },
{ updatingUserId: req.user.id, forceVersion: true },
);
- const deleted = await deleteAction({ action_id, agent_id });
+ const deleted = await db.deleteAction({ action_id, agent_id });
if (!deleted) {
logger.warn('[Agent Action Delete] No matching action document found', {
action_id,
diff --git a/api/server/routes/agents/chat.js b/api/server/routes/agents/chat.js
index 37b83f4f54..0543b0b1aa 100644
--- a/api/server/routes/agents/chat.js
+++ b/api/server/routes/agents/chat.js
@@ -11,7 +11,7 @@ const {
const { initializeClient } = require('~/server/services/Endpoints/agents');
const AgentController = require('~/server/controllers/agents/request');
const addTitle = require('~/server/services/Endpoints/agents/title');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
const router = express.Router();
diff --git a/api/server/routes/agents/index.js b/api/server/routes/agents/index.js
index a99fdca592..86966a3f3e 100644
--- a/api/server/routes/agents/index.js
+++ b/api/server/routes/agents/index.js
@@ -10,8 +10,8 @@ const {
messageUserLimiter,
} = require('~/server/middleware');
const { saveMessage } = require('~/models');
-const openai = require('./openai');
const responses = require('./responses');
+const openai = require('./openai');
const { v1 } = require('./v1');
const chat = require('./chat');
@@ -263,9 +263,15 @@ router.post('/chat/abort', async (req, res) => {
};
try {
- await saveMessage(req, responseMessage, {
- context: 'api/server/routes/agents/index.js - abort endpoint',
- });
+ await saveMessage(
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
+ responseMessage,
+ { context: 'api/server/routes/agents/index.js - abort endpoint' },
+ );
logger.debug(`[AgentStream] Saved partial response for: ${jobStreamId}`);
} catch (saveError) {
logger.error(`[AgentStream] Failed to save partial response: ${saveError.message}`);
diff --git a/api/server/routes/agents/openai.js b/api/server/routes/agents/openai.js
index 9a0d9a3564..72e3da6c5a 100644
--- a/api/server/routes/agents/openai.js
+++ b/api/server/routes/agents/openai.js
@@ -29,26 +29,24 @@ const {
GetModelController,
} = require('~/server/controllers/agents/openai');
const { getEffectivePermissions } = require('~/server/services/PermissionService');
-const { validateAgentApiKey, findUser } = require('~/models');
const { configMiddleware } = require('~/server/middleware');
-const { getRoleByName } = require('~/models/Role');
-const { getAgent } = require('~/models/Agent');
+const db = require('~/models');
const router = express.Router();
const requireApiKeyAuth = createRequireApiKeyAuth({
- validateAgentApiKey,
- findUser,
+ validateAgentApiKey: db.validateAgentApiKey,
+ findUser: db.findUser,
});
const checkRemoteAgentsFeature = generateCheckAccess({
permissionType: PermissionTypes.REMOTE_AGENTS,
permissions: [Permissions.USE],
- getRoleByName,
+ getRoleByName: db.getRoleByName,
});
const checkAgentPermission = createCheckRemoteAgentAccess({
- getAgent,
+ getAgent: db.getAgent,
getEffectivePermissions,
});
diff --git a/api/server/routes/agents/responses.js b/api/server/routes/agents/responses.js
index 431942e921..2c118e0597 100644
--- a/api/server/routes/agents/responses.js
+++ b/api/server/routes/agents/responses.js
@@ -32,26 +32,24 @@ const {
listModels,
} = require('~/server/controllers/agents/responses');
const { getEffectivePermissions } = require('~/server/services/PermissionService');
-const { validateAgentApiKey, findUser } = require('~/models');
const { configMiddleware } = require('~/server/middleware');
-const { getRoleByName } = require('~/models/Role');
-const { getAgent } = require('~/models/Agent');
+const db = require('~/models');
const router = express.Router();
const requireApiKeyAuth = createRequireApiKeyAuth({
- validateAgentApiKey,
- findUser,
+ validateAgentApiKey: db.validateAgentApiKey,
+ findUser: db.findUser,
});
const checkRemoteAgentsFeature = generateCheckAccess({
permissionType: PermissionTypes.REMOTE_AGENTS,
permissions: [Permissions.USE],
- getRoleByName,
+ getRoleByName: db.getRoleByName,
});
const checkAgentPermission = createCheckRemoteAgentAccess({
- getAgent,
+ getAgent: db.getAgent,
getEffectivePermissions,
});
diff --git a/api/server/routes/agents/v1.js b/api/server/routes/agents/v1.js
index 0c7d23f8ad..c4f90d0bd5 100644
--- a/api/server/routes/agents/v1.js
+++ b/api/server/routes/agents/v1.js
@@ -3,7 +3,7 @@ const { generateCheckAccess } = require('@librechat/api');
const { PermissionTypes, Permissions, PermissionBits } = require('librechat-data-provider');
const { requireJwtAuth, configMiddleware, canAccessAgentResource } = require('~/server/middleware');
const v1 = require('~/server/controllers/agents/v1');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
const actions = require('./actions');
const tools = require('./tools');
diff --git a/api/server/routes/apiKeys.js b/api/server/routes/apiKeys.js
index 29dcc326f5..ee11a8b0dd 100644
--- a/api/server/routes/apiKeys.js
+++ b/api/server/routes/apiKeys.js
@@ -6,9 +6,9 @@ const {
createAgentApiKey,
deleteAgentApiKey,
listAgentApiKeys,
+ getRoleByName,
} = require('~/models');
const { requireJwtAuth } = require('~/server/middleware');
-const { getRoleByName } = require('~/models/Role');
const router = express.Router();
diff --git a/api/server/routes/assistants/actions.js b/api/server/routes/assistants/actions.js
index 75ab879e2b..977d3f92a7 100644
--- a/api/server/routes/assistants/actions.js
+++ b/api/server/routes/assistants/actions.js
@@ -9,8 +9,7 @@ const {
domainParser,
} = require('~/server/services/ActionService');
const { getOpenAIClient } = require('~/server/controllers/assistants/helpers');
-const { updateAction, getActions, deleteAction } = require('~/models/Action');
-const { updateAssistantDoc, getAssistant } = require('~/models/Assistant');
+const db = require('~/models');
const router = express.Router();
@@ -56,9 +55,9 @@ router.post('/:assistant_id', async (req, res) => {
const { openai } = await getOpenAIClient({ req, res });
- initialPromises.push(getAssistant({ assistant_id }));
+ initialPromises.push(db.getAssistant({ assistant_id }));
initialPromises.push(openai.beta.assistants.retrieve(assistant_id));
- !!_action_id && initialPromises.push(getActions({ action_id }, true));
+ !!_action_id && initialPromises.push(db.getActions({ action_id }, true));
/** @type {[AssistantDocument, Assistant, [Action|undefined]]} */
const [assistant_data, assistant, actions_result] = await Promise.all(initialPromises);
@@ -121,7 +120,7 @@ router.post('/:assistant_id', async (req, res) => {
if (!assistant_data) {
assistantUpdateData.user = req.user.id;
}
- promises.push(updateAssistantDoc({ assistant_id }, assistantUpdateData));
+ promises.push(db.updateAssistantDoc({ assistant_id }, assistantUpdateData));
// Only update user field for new actions
const actionUpdateData = { metadata, assistant_id };
@@ -129,7 +128,7 @@ router.post('/:assistant_id', async (req, res) => {
// For new actions, use the assistant owner's user ID
actionUpdateData.user = assistant_user || req.user.id;
}
- promises.push(updateAction({ action_id, assistant_id }, actionUpdateData));
+ promises.push(db.updateAction({ action_id, assistant_id }, actionUpdateData));
/** @type {[AssistantDocument, Action]} */
let [assistantDocument, updatedAction] = await Promise.all(promises);
@@ -171,7 +170,7 @@ router.delete('/:assistant_id/:action_id/:model', async (req, res) => {
const { openai } = await getOpenAIClient({ req, res });
const initialPromises = [];
- initialPromises.push(getAssistant({ assistant_id }));
+ initialPromises.push(db.getAssistant({ assistant_id }));
initialPromises.push(openai.beta.assistants.retrieve(assistant_id));
/** @type {[AssistantDocument, Assistant]} */
@@ -209,8 +208,8 @@ router.delete('/:assistant_id/:action_id/:model', async (req, res) => {
if (!assistant_data) {
assistantUpdateData.user = req.user.id;
}
- promises.push(updateAssistantDoc({ assistant_id }, assistantUpdateData));
- promises.push(deleteAction({ action_id, assistant_id }));
+ promises.push(db.updateAssistantDoc({ assistant_id }, assistantUpdateData));
+ promises.push(db.deleteAction({ action_id, assistant_id }));
const [, deletedAction] = await Promise.all(promises);
if (!deletedAction) {
diff --git a/api/server/routes/auth.js b/api/server/routes/auth.js
index d55684f3de..c660e6f99d 100644
--- a/api/server/routes/auth.js
+++ b/api/server/routes/auth.js
@@ -17,13 +17,14 @@ const {
const { verify2FAWithTempToken } = require('~/server/controllers/auth/TwoFactorAuthController');
const { logoutController } = require('~/server/controllers/auth/LogoutController');
const { loginController } = require('~/server/controllers/auth/LoginController');
+const { findBalanceByUser, upsertBalanceFields } = require('~/models');
const { getAppConfig } = require('~/server/services/Config');
const middleware = require('~/server/middleware');
-const { Balance } = require('~/db/models');
const setBalanceConfig = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const router = express.Router();
diff --git a/api/server/routes/banner.js b/api/server/routes/banner.js
index cf7eafd017..ad949fd2ca 100644
--- a/api/server/routes/banner.js
+++ b/api/server/routes/banner.js
@@ -1,13 +1,15 @@
const express = require('express');
-
-const { getBanner } = require('~/models/Banner');
+const { logger } = require('@librechat/data-schemas');
const optionalJwtAuth = require('~/server/middleware/optionalJwtAuth');
+const { getBanner } = require('~/models');
+
const router = express.Router();
router.get('/', optionalJwtAuth, async (req, res) => {
try {
res.status(200).send(await getBanner(req.user));
} catch (error) {
+ logger.error('[getBanner] Error getting banner', error);
res.status(500).json({ message: 'Error getting banner' });
}
});
diff --git a/api/server/routes/categories.js b/api/server/routes/categories.js
index da1828b3ce..612bc37860 100644
--- a/api/server/routes/categories.js
+++ b/api/server/routes/categories.js
@@ -1,7 +1,7 @@
const express = require('express');
const router = express.Router();
const { requireJwtAuth } = require('~/server/middleware');
-const { getCategories } = require('~/models/Categories');
+const { getCategories } = require('~/models');
router.get('/', requireJwtAuth, async (req, res) => {
try {
diff --git a/api/server/routes/convos.js b/api/server/routes/convos.js
index 578796170a..1964075ed3 100644
--- a/api/server/routes/convos.js
+++ b/api/server/routes/convos.js
@@ -10,14 +10,12 @@ const {
createForkLimiters,
configMiddleware,
} = require('~/server/middleware');
-const { getConvosByCursor, deleteConvos, getConvo, saveConvo } = require('~/models/Conversation');
const { forkConversation, duplicateConversation } = require('~/server/utils/import/fork');
const { storage, importFileFilter } = require('~/server/routes/files/multer');
-const { deleteAllSharedLinks, deleteConvoSharedLink } = require('~/models');
const requireJwtAuth = require('~/server/middleware/requireJwtAuth');
const { importConversations } = require('~/server/utils/import');
-const { deleteToolCalls } = require('~/models/ToolCall');
const getLogStores = require('~/cache/getLogStores');
+const db = require('~/models');
const assistantClients = {
[EModelEndpoint.azureAssistants]: require('~/server/services/Endpoints/azureAssistants'),
@@ -41,7 +39,7 @@ router.get('/', async (req, res) => {
}
try {
- const result = await getConvosByCursor(req.user.id, {
+ const result = await db.getConvosByCursor(req.user.id, {
cursor,
limit,
isArchived,
@@ -59,7 +57,7 @@ router.get('/', async (req, res) => {
router.get('/:conversationId', async (req, res) => {
const { conversationId } = req.params;
- const convo = await getConvo(req.user.id, conversationId);
+ const convo = await db.getConvo(req.user.id, conversationId);
if (convo) {
res.status(200).json(convo);
@@ -128,10 +126,10 @@ router.delete('/', async (req, res) => {
}
try {
- const dbResponse = await deleteConvos(req.user.id, filter);
+ const dbResponse = await db.deleteConvos(req.user.id, filter);
if (filter.conversationId) {
- await deleteToolCalls(req.user.id, filter.conversationId);
- await deleteConvoSharedLink(req.user.id, filter.conversationId);
+ await db.deleteToolCalls(req.user.id, filter.conversationId);
+ await db.deleteConvoSharedLink(req.user.id, filter.conversationId);
}
res.status(201).json(dbResponse);
} catch (error) {
@@ -142,9 +140,9 @@ router.delete('/', async (req, res) => {
router.delete('/all', async (req, res) => {
try {
- const dbResponse = await deleteConvos(req.user.id, {});
- await deleteToolCalls(req.user.id);
- await deleteAllSharedLinks(req.user.id);
+ const dbResponse = await db.deleteConvos(req.user.id, {});
+ await db.deleteToolCalls(req.user.id);
+ await db.deleteAllSharedLinks(req.user.id);
res.status(201).json(dbResponse);
} catch (error) {
logger.error('Error clearing conversations', error);
@@ -171,8 +169,12 @@ router.post('/archive', validateConvoAccess, async (req, res) => {
}
try {
- const dbResponse = await saveConvo(
- req,
+ const dbResponse = await db.saveConvo(
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{ conversationId, isArchived },
{ context: `POST /api/convos/archive ${conversationId}` },
);
@@ -211,8 +213,12 @@ router.post('/update', validateConvoAccess, async (req, res) => {
const sanitizedTitle = title.trim().slice(0, MAX_CONVO_TITLE_LENGTH);
try {
- const dbResponse = await saveConvo(
- req,
+ const dbResponse = await db.saveConvo(
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{ conversationId, title: sanitizedTitle },
{ context: `POST /api/convos/update ${conversationId}` },
);
diff --git a/api/server/routes/files/files.agents.test.js b/api/server/routes/files/files.agents.test.js
index 7c21e95234..203c1210fd 100644
--- a/api/server/routes/files/files.agents.test.js
+++ b/api/server/routes/files/files.agents.test.js
@@ -10,8 +10,7 @@ const {
ResourceType,
PrincipalType,
} = require('librechat-data-provider');
-const { createAgent } = require('~/models/Agent');
-const { createFile } = require('~/models');
+const { createAgent, createFile } = require('~/models');
// Only mock the external dependencies that we don't want to test
jest.mock('~/server/services/Files/process', () => ({
diff --git a/api/server/routes/files/files.js b/api/server/routes/files/files.js
index fdb7768c3b..a51c00f26e 100644
--- a/api/server/routes/files/files.js
+++ b/api/server/routes/files/files.js
@@ -27,25 +27,23 @@ const { checkPermission } = require('~/server/services/PermissionService');
const { loadAuthValues } = require('~/server/services/Tools/credentials');
const { refreshS3FileUrls } = require('~/server/services/Files/S3/crud');
const { hasAccessToFilesViaAgent } = require('~/server/services/Files');
-const { getFiles, batchUpdateFiles } = require('~/models');
const { cleanFileName } = require('~/server/utils/files');
-const { getAssistant } = require('~/models/Assistant');
-const { getAgent } = require('~/models/Agent');
const { getLogStores } = require('~/cache');
const { Readable } = require('stream');
+const db = require('~/models');
const router = express.Router();
router.get('/', async (req, res) => {
try {
const appConfig = req.config;
- const files = await getFiles({ user: req.user.id });
+ const files = await db.getFiles({ user: req.user.id });
if (appConfig.fileStrategy === FileSources.s3) {
try {
const cache = getLogStores(CacheKeys.S3_EXPIRY_INTERVAL);
const alreadyChecked = await cache.get(req.user.id);
if (!alreadyChecked) {
- await refreshS3FileUrls(files, batchUpdateFiles);
+ await refreshS3FileUrls(files, db.batchUpdateFiles);
await cache.set(req.user.id, true, Time.THIRTY_MINUTES);
}
} catch (error) {
@@ -74,7 +72,7 @@ router.get('/agent/:agent_id', async (req, res) => {
return res.status(400).json({ error: 'Agent ID is required' });
}
- const agent = await getAgent({ id: agent_id });
+ const agent = await db.getAgent({ id: agent_id });
if (!agent) {
return res.status(200).json([]);
}
@@ -106,7 +104,7 @@ router.get('/agent/:agent_id', async (req, res) => {
return res.status(200).json([]);
}
- const files = await getFiles({ file_id: { $in: agentFileIds } }, null, { text: 0 });
+ const files = await db.getFiles({ file_id: { $in: agentFileIds } }, null, { text: 0 });
res.status(200).json(files);
} catch (error) {
@@ -151,7 +149,7 @@ router.delete('/', async (req, res) => {
}
const fileIds = files.map((file) => file.file_id);
- const dbFiles = await getFiles({ file_id: { $in: fileIds } });
+ const dbFiles = await db.getFiles({ file_id: { $in: fileIds } });
const ownedFiles = [];
const nonOwnedFiles = [];
@@ -209,7 +207,7 @@ router.delete('/', async (req, res) => {
/* Handle agent unlinking even if no valid files to delete */
if (req.body.agent_id && req.body.tool_resource && dbFiles.length === 0) {
- const agent = await getAgent({
+ const agent = await db.getAgent({
id: req.body.agent_id,
});
@@ -223,7 +221,7 @@ router.delete('/', async (req, res) => {
/* Handle assistant unlinking even if no valid files to delete */
if (req.body.assistant_id && req.body.tool_resource && dbFiles.length === 0) {
- const assistant = await getAssistant({
+ const assistant = await db.getAssistant({
id: req.body.assistant_id,
});
@@ -385,7 +383,7 @@ router.post('/', async (req, res) => {
req,
res,
metadata,
- getAgent,
+ getAgent: db.getAgent,
checkPermission,
});
if (denied) {
diff --git a/api/server/routes/files/files.test.js b/api/server/routes/files/files.test.js
index 1d548b44be..457ebabe92 100644
--- a/api/server/routes/files/files.test.js
+++ b/api/server/routes/files/files.test.js
@@ -10,8 +10,7 @@ const {
AccessRoleIds,
PrincipalType,
} = require('librechat-data-provider');
-const { createAgent } = require('~/models/Agent');
-const { createFile } = require('~/models');
+const { createAgent, createFile } = require('~/models');
// Only mock the external dependencies that we don't want to test
jest.mock('~/server/services/Files/process', () => ({
diff --git a/api/server/routes/mcp.js b/api/server/routes/mcp.js
index 57a99d199a..d6d7ed5ea0 100644
--- a/api/server/routes/mcp.js
+++ b/api/server/routes/mcp.js
@@ -38,13 +38,11 @@ const {
} = require('~/config');
const { getMCPSetupData, getServerConnectionStatus } = require('~/server/services/MCP');
const { requireJwtAuth, canAccessMCPServerResource } = require('~/server/middleware');
-const { findToken, updateToken, createToken, deleteTokens } = require('~/models');
const { getUserPluginAuthValue } = require('~/server/services/PluginService');
const { updateMCPServerTools } = require('~/server/services/Config/mcp');
const { reinitMCPServer } = require('~/server/services/Tools/mcp');
-const { findPluginAuthsByKeys } = require('~/models');
-const { getRoleByName } = require('~/models/Role');
const { getLogStores } = require('~/cache');
+const db = require('~/models');
const router = Router();
@@ -53,13 +51,13 @@ const OAUTH_CSRF_COOKIE_PATH = '/api/mcp';
const checkMCPUsePermissions = generateCheckAccess({
permissionType: PermissionTypes.MCP_SERVERS,
permissions: [Permissions.USE],
- getRoleByName,
+ getRoleByName: db.getRoleByName,
});
const checkMCPCreate = generateCheckAccess({
permissionType: PermissionTypes.MCP_SERVERS,
permissions: [Permissions.USE, Permissions.CREATE],
- getRoleByName,
+ getRoleByName: db.getRoleByName,
});
/**
@@ -246,9 +244,9 @@ router.get('/:serverName/oauth/callback', async (req, res) => {
userId: flowState.userId,
serverName,
tokens,
- createToken,
- updateToken,
- findToken,
+ createToken: db.createToken,
+ updateToken: db.updateToken,
+ findToken: db.findToken,
clientInfo: flowState.clientInfo,
metadata: flowState.metadata,
});
@@ -286,10 +284,10 @@ router.get('/:serverName/oauth/callback', async (req, res) => {
serverName,
flowManager,
tokenMethods: {
- findToken,
- updateToken,
- createToken,
- deleteTokens,
+ findToken: db.findToken,
+ updateToken: db.updateToken,
+ createToken: db.createToken,
+ deleteTokens: db.deleteTokens,
},
});
@@ -517,7 +515,7 @@ router.post(
userMCPAuthMap = await getUserMCPAuthMap({
userId: user.id,
servers: [serverName],
- findPluginAuthsByKeys,
+ findPluginAuthsByKeys: db.findPluginAuthsByKeys,
});
}
diff --git a/api/server/routes/memories.js b/api/server/routes/memories.js
index 58955d8ec4..e71e94f457 100644
--- a/api/server/routes/memories.js
+++ b/api/server/routes/memories.js
@@ -4,12 +4,12 @@ const { PermissionTypes, Permissions } = require('librechat-data-provider');
const {
getAllUserMemories,
toggleUserMemories,
+ getRoleByName,
createMemory,
deleteMemory,
setMemory,
} = require('~/models');
const { requireJwtAuth, configMiddleware } = require('~/server/middleware');
-const { getRoleByName } = require('~/models/Role');
const router = express.Router();
diff --git a/api/server/routes/messages.js b/api/server/routes/messages.js
index 03286bc7f1..21b2b23fea 100644
--- a/api/server/routes/messages.js
+++ b/api/server/routes/messages.js
@@ -3,18 +3,9 @@ const { v4: uuidv4 } = require('uuid');
const { logger } = require('@librechat/data-schemas');
const { ContentTypes } = require('librechat-data-provider');
const { unescapeLaTeX, countTokens } = require('@librechat/api');
-const {
- saveConvo,
- getMessage,
- saveMessage,
- getMessages,
- updateMessage,
- deleteMessages,
-} = require('~/models');
const { findAllArtifacts, replaceArtifactContent } = require('~/server/services/Artifacts/update');
const { requireJwtAuth, validateMessageReq } = require('~/server/middleware');
-const { getConvosQueried } = require('~/models/Conversation');
-const { Message } = require('~/db/models');
+const db = require('~/models');
const router = express.Router();
router.use(requireJwtAuth);
@@ -40,34 +31,19 @@ router.get('/', async (req, res) => {
const sortOrder = sortDirection === 'asc' ? 1 : -1;
if (conversationId && messageId) {
- const message = await Message.findOne({
- conversationId,
- messageId,
- user: user,
- }).lean();
- response = { messages: message ? [message] : [], nextCursor: null };
+ const messages = await db.getMessages({ conversationId, messageId, user });
+ response = { messages: messages?.length ? [messages[0]] : [], nextCursor: null };
} else if (conversationId) {
- const filter = { conversationId, user: user };
- if (cursor) {
- filter[sortField] = sortOrder === 1 ? { $gt: cursor } : { $lt: cursor };
- }
- const messages = await Message.find(filter)
- .sort({ [sortField]: sortOrder })
- .limit(pageSize + 1)
- .lean();
- let nextCursor = null;
- if (messages.length > pageSize) {
- messages.pop(); // Remove extra item used to detect next page
- // Create cursor from the last RETURNED item (not the popped one)
- nextCursor = messages[messages.length - 1][sortField];
- }
- response = { messages, nextCursor };
+ response = await db.getMessagesByCursor(
+ { conversationId, user },
+ { sortField, sortOrder, limit: pageSize, cursor },
+ );
} else if (search) {
- const searchResults = await Message.meiliSearch(search, { filter: `user = "${user}"` }, true);
+ const searchResults = await db.searchMessages(search, { filter: `user = "${user}"` }, true);
const messages = searchResults.hits || [];
- const result = await getConvosQueried(req.user.id, messages, cursor);
+ const result = await db.getConvosQueried(req.user.id, messages, cursor);
const messageIds = [];
const cleanedMessages = [];
@@ -79,7 +55,7 @@ router.get('/', async (req, res) => {
}
}
- const dbMessages = await getMessages({
+ const dbMessages = await db.getMessages({
user,
messageId: { $in: messageIds },
});
@@ -136,7 +112,7 @@ router.post('/branch', async (req, res) => {
return res.status(400).json({ error: 'messageId and agentId are required' });
}
- const sourceMessage = await getMessage({ user: userId, messageId });
+ const sourceMessage = await db.getMessage({ user: userId, messageId });
if (!sourceMessage) {
return res.status(404).json({ error: 'Source message not found' });
}
@@ -187,9 +163,15 @@ router.post('/branch', async (req, res) => {
user: userId,
};
- const savedMessage = await saveMessage(req, newMessage, {
- context: 'POST /api/messages/branch',
- });
+ const savedMessage = await db.saveMessage(
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
+ newMessage,
+ { context: 'POST /api/messages/branch' },
+ );
if (!savedMessage) {
return res.status(500).json({ error: 'Failed to save branch message' });
@@ -211,7 +193,7 @@ router.post('/artifact/:messageId', async (req, res) => {
return res.status(400).json({ error: 'Invalid request parameters' });
}
- const message = await getMessage({ user: req.user.id, messageId });
+ const message = await db.getMessage({ user: req.user.id, messageId });
if (!message) {
return res.status(404).json({ error: 'Message not found' });
}
@@ -256,8 +238,12 @@ router.post('/artifact/:messageId', async (req, res) => {
return res.status(400).json({ error: 'Original content not found in target artifact' });
}
- const savedMessage = await saveMessage(
- req,
+ const savedMessage = await db.saveMessage(
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{
messageId,
conversationId: message.conversationId,
@@ -283,7 +269,7 @@ router.post('/artifact/:messageId', async (req, res) => {
router.get('/:conversationId', validateMessageReq, async (req, res) => {
try {
const { conversationId } = req.params;
- const messages = await getMessages({ conversationId }, '-_id -__v -user');
+ const messages = await db.getMessages({ conversationId }, '-_id -__v -user');
res.status(200).json(messages);
} catch (error) {
logger.error('Error fetching messages:', error);
@@ -294,15 +280,20 @@ router.get('/:conversationId', validateMessageReq, async (req, res) => {
router.post('/:conversationId', validateMessageReq, async (req, res) => {
try {
const message = req.body;
- const savedMessage = await saveMessage(
- req,
+ const reqCtx = {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ };
+ const savedMessage = await db.saveMessage(
+ reqCtx,
{ ...message, user: req.user.id },
{ context: 'POST /api/messages/:conversationId' },
);
if (!savedMessage) {
return res.status(400).json({ error: 'Message not saved' });
}
- await saveConvo(req, savedMessage, { context: 'POST /api/messages/:conversationId' });
+ await db.saveConvo(reqCtx, savedMessage, { context: 'POST /api/messages/:conversationId' });
res.status(201).json(savedMessage);
} catch (error) {
logger.error('Error saving message:', error);
@@ -313,7 +304,7 @@ router.post('/:conversationId', validateMessageReq, async (req, res) => {
router.get('/:conversationId/:messageId', validateMessageReq, async (req, res) => {
try {
const { conversationId, messageId } = req.params;
- const message = await getMessages({ conversationId, messageId }, '-_id -__v -user');
+ const message = await db.getMessages({ conversationId, messageId }, '-_id -__v -user');
if (!message) {
return res.status(404).json({ error: 'Message not found' });
}
@@ -331,7 +322,7 @@ router.put('/:conversationId/:messageId', validateMessageReq, async (req, res) =
if (index === undefined) {
const tokenCount = await countTokens(text, model);
- const result = await updateMessage(req, { messageId, text, tokenCount });
+ const result = await db.updateMessage(req?.user?.id, { messageId, text, tokenCount });
return res.status(200).json(result);
}
@@ -339,7 +330,9 @@ router.put('/:conversationId/:messageId', validateMessageReq, async (req, res) =
return res.status(400).json({ error: 'Invalid index' });
}
- const message = (await getMessages({ conversationId, messageId }, 'content tokenCount'))?.[0];
+ const message = (
+ await db.getMessages({ conversationId, messageId }, 'content tokenCount')
+ )?.[0];
if (!message) {
return res.status(404).json({ error: 'Message not found' });
}
@@ -369,7 +362,11 @@ router.put('/:conversationId/:messageId', validateMessageReq, async (req, res) =
tokenCount = Math.max(0, tokenCount - oldTokenCount) + newTokenCount;
}
- const result = await updateMessage(req, { messageId, content: updatedContent, tokenCount });
+ const result = await db.updateMessage(req?.user?.id, {
+ messageId,
+ content: updatedContent,
+ tokenCount,
+ });
return res.status(200).json(result);
} catch (error) {
logger.error('Error updating message:', error);
@@ -382,8 +379,8 @@ router.put('/:conversationId/:messageId/feedback', validateMessageReq, async (re
const { conversationId, messageId } = req.params;
const { feedback } = req.body;
- const updatedMessage = await updateMessage(
- req,
+ const updatedMessage = await db.updateMessage(
+ req?.user?.id,
{
messageId,
feedback: feedback || null,
@@ -405,7 +402,7 @@ router.put('/:conversationId/:messageId/feedback', validateMessageReq, async (re
router.delete('/:conversationId/:messageId', validateMessageReq, async (req, res) => {
try {
const { conversationId, messageId } = req.params;
- await deleteMessages({ messageId, conversationId, user: req.user.id });
+ await db.deleteMessages({ messageId, conversationId, user: req.user.id });
res.status(204).send();
} catch (error) {
logger.error('Error deleting message:', error);
diff --git a/api/server/routes/oauth.js b/api/server/routes/oauth.js
index f4bb5b6026..5302158031 100644
--- a/api/server/routes/oauth.js
+++ b/api/server/routes/oauth.js
@@ -7,12 +7,13 @@ const { ErrorTypes } = require('librechat-data-provider');
const { createSetBalanceConfig } = require('@librechat/api');
const { checkDomainAllowed, loginLimiter, logHeaders } = require('~/server/middleware');
const { createOAuthHandler } = require('~/server/controllers/auth/oauth');
+const { findBalanceByUser, upsertBalanceFields } = require('~/models');
const { getAppConfig } = require('~/server/services/Config');
-const { Balance } = require('~/db/models');
const setBalanceConfig = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const router = express.Router();
diff --git a/api/server/routes/prompts.js b/api/server/routes/prompts.js
index a0fe65ffd1..d437273df2 100644
--- a/api/server/routes/prompts.js
+++ b/api/server/routes/prompts.js
@@ -25,11 +25,12 @@ const {
deletePromptGroup,
createPromptGroup,
getPromptGroup,
+ getRoleByName,
deletePrompt,
getPrompts,
savePrompt,
getPrompt,
-} = require('~/models/Prompt');
+} = require('~/models');
const {
canAccessPromptGroupResource,
canAccessPromptViaGroup,
@@ -41,7 +42,6 @@ const {
findAccessibleResources,
grantPermission,
} = require('~/server/services/PermissionService');
-const { getRoleByName } = require('~/models/Role');
const router = express.Router();
diff --git a/api/server/routes/prompts.test.js b/api/server/routes/prompts.test.js
index caeb90ddfb..80c973147f 100644
--- a/api/server/routes/prompts.test.js
+++ b/api/server/routes/prompts.test.js
@@ -16,9 +16,22 @@ jest.mock('~/server/services/Config', () => ({
getCachedTools: jest.fn().mockResolvedValue({}),
}));
-jest.mock('~/models/Role', () => ({
- getRoleByName: jest.fn(),
-}));
+jest.mock('~/models', () => {
+ const mongoose = require('mongoose');
+ const { createMethods } = require('@librechat/data-schemas');
+ const methods = createMethods(mongoose, {
+ removeAllPermissions: async ({ resourceType, resourceId }) => {
+ const AclEntry = mongoose.models.AclEntry;
+ if (AclEntry) {
+ await AclEntry.deleteMany({ resourceType, resourceId });
+ }
+ },
+ });
+ return {
+ ...methods,
+ getRoleByName: jest.fn(),
+ };
+});
jest.mock('~/server/middleware', () => ({
requireJwtAuth: (req, res, next) => next(),
@@ -153,7 +166,7 @@ async function setupTestData() {
};
// Mock getRoleByName
- const { getRoleByName } = require('~/models/Role');
+ const { getRoleByName } = require('~/models');
getRoleByName.mockImplementation((roleName) => {
switch (roleName) {
case SystemRoles.USER:
diff --git a/api/server/routes/roles.js b/api/server/routes/roles.js
index 12e18c7624..4c0f044f76 100644
--- a/api/server/routes/roles.js
+++ b/api/server/routes/roles.js
@@ -12,7 +12,7 @@ const {
remoteAgentsPermissionsSchema,
} = require('librechat-data-provider');
const { checkAdmin, requireJwtAuth } = require('~/server/middleware');
-const { updateRoleByName, getRoleByName } = require('~/models/Role');
+const { updateRoleByName, getRoleByName } = require('~/models');
const router = express.Router();
router.use(requireJwtAuth);
diff --git a/api/server/routes/tags.js b/api/server/routes/tags.js
index 0a4ee5084c..a1fa1f77bb 100644
--- a/api/server/routes/tags.js
+++ b/api/server/routes/tags.js
@@ -8,9 +8,9 @@ const {
createConversationTag,
deleteConversationTag,
getConversationTags,
-} = require('~/models/ConversationTag');
+ getRoleByName,
+} = require('~/models');
const { requireJwtAuth } = require('~/server/middleware');
-const { getRoleByName } = require('~/models/Role');
const router = express.Router();
diff --git a/api/server/services/ActionService.js b/api/server/services/ActionService.js
index bde052bba4..c8ed7bebc4 100644
--- a/api/server/services/ActionService.js
+++ b/api/server/services/ActionService.js
@@ -20,9 +20,14 @@ const {
isImageVisionTool,
actionDomainSeparator,
} = require('librechat-data-provider');
-const { findToken, updateToken, createToken } = require('~/models');
-const { getActions, deleteActions } = require('~/models/Action');
-const { deleteAssistant } = require('~/models/Assistant');
+const {
+ findToken,
+ updateToken,
+ createToken,
+ getActions,
+ deleteActions,
+ deleteAssistant,
+} = require('~/models');
const { getFlowStateManager } = require('~/config');
const { getLogStores } = require('~/cache');
diff --git a/api/server/services/Endpoints/agents/addedConvo.js b/api/server/services/Endpoints/agents/addedConvo.js
index 11b87e450e..7561053f8f 100644
--- a/api/server/services/Endpoints/agents/addedConvo.js
+++ b/api/server/services/Endpoints/agents/addedConvo.js
@@ -1,13 +1,16 @@
const { logger } = require('@librechat/data-schemas');
-const { initializeAgent, validateAgentModel } = require('@librechat/api');
-const { loadAddedAgent, setGetAgent, ADDED_AGENT_ID } = require('~/models/loadAddedAgent');
+const {
+ ADDED_AGENT_ID,
+ initializeAgent,
+ validateAgentModel,
+ loadAddedAgent: loadAddedAgentFn,
+} = require('@librechat/api');
const { filterFilesByAgentAccess } = require('~/server/services/Files/permissions');
-const { getConvoFiles } = require('~/models/Conversation');
-const { getAgent } = require('~/models/Agent');
+const { getMCPServerTools } = require('~/server/services/Config');
const db = require('~/models');
-// Initialize the getAgent dependency
-setGetAgent(getAgent);
+const loadAddedAgent = (params) =>
+ loadAddedAgentFn(params, { getAgent: db.getAgent, getMCPServerTools });
/**
* Process addedConvo for parallel agent execution.
@@ -100,10 +103,10 @@ const processAddedConvo = async ({
allowedProviders,
},
{
- getConvoFiles,
getFiles: db.getFiles,
getUserKey: db.getUserKey,
getMessages: db.getMessages,
+ getConvoFiles: db.getConvoFiles,
updateFilesUsage: db.updateFilesUsage,
getUserCodeFiles: db.getUserCodeFiles,
getUserKeyValues: db.getUserKeyValues,
diff --git a/api/server/services/Endpoints/agents/build.js b/api/server/services/Endpoints/agents/build.js
index a95640e528..19ae3ab7e8 100644
--- a/api/server/services/Endpoints/agents/build.js
+++ b/api/server/services/Endpoints/agents/build.js
@@ -1,6 +1,10 @@
const { logger } = require('@librechat/data-schemas');
+const { loadAgent: loadAgentFn } = require('@librechat/api');
const { isAgentsEndpoint, removeNullishValues, Constants } = require('librechat-data-provider');
-const { loadAgent } = require('~/models/Agent');
+const { getMCPServerTools } = require('~/server/services/Config');
+const db = require('~/models');
+
+const loadAgent = (params) => loadAgentFn(params, { getAgent: db.getAgent, getMCPServerTools });
const buildOptions = (req, endpoint, parsedBody, endpointType) => {
const { spec, iconURL, agent_id, ...model_parameters } = parsedBody;
diff --git a/api/server/services/Endpoints/agents/initialize.js b/api/server/services/Endpoints/agents/initialize.js
index 08f631c3d2..28282e68ea 100644
--- a/api/server/services/Endpoints/agents/initialize.js
+++ b/api/server/services/Endpoints/agents/initialize.js
@@ -26,9 +26,7 @@ const { filterFilesByAgentAccess } = require('~/server/services/Files/permission
const { getModelsConfig } = require('~/server/controllers/ModelController');
const { checkPermission } = require('~/server/services/PermissionService');
const AgentClient = require('~/server/controllers/agents/client');
-const { getConvoFiles } = require('~/models/Conversation');
const { processAddedConvo } = require('./addedConvo');
-const { getAgent } = require('~/models/Agent');
const { logViolation } = require('~/cache');
const db = require('~/models');
@@ -196,10 +194,10 @@ const initializeClient = async ({ req, res, signal, endpointOption }) => {
isInitialAgent: true,
},
{
- getConvoFiles,
getFiles: db.getFiles,
getUserKey: db.getUserKey,
getMessages: db.getMessages,
+ getConvoFiles: db.getConvoFiles,
updateFilesUsage: db.updateFilesUsage,
getUserKeyValues: db.getUserKeyValues,
getUserCodeFiles: db.getUserCodeFiles,
@@ -227,7 +225,7 @@ const initializeClient = async ({ req, res, signal, endpointOption }) => {
const skippedAgentIds = new Set();
async function processAgent(agentId) {
- const agent = await getAgent({ id: agentId });
+ const agent = await db.getAgent({ id: agentId });
if (!agent) {
logger.warn(
`[processAgent] Handoff agent ${agentId} not found, skipping (orphaned reference)`,
@@ -277,10 +275,10 @@ const initializeClient = async ({ req, res, signal, endpointOption }) => {
allowedProviders,
},
{
- getConvoFiles,
getFiles: db.getFiles,
getUserKey: db.getUserKey,
getMessages: db.getMessages,
+ getConvoFiles: db.getConvoFiles,
updateFilesUsage: db.updateFilesUsage,
getUserKeyValues: db.getUserKeyValues,
getUserCodeFiles: db.getUserCodeFiles,
diff --git a/api/server/services/Endpoints/agents/title.js b/api/server/services/Endpoints/agents/title.js
index e31cdeea11..b7e1a54e06 100644
--- a/api/server/services/Endpoints/agents/title.js
+++ b/api/server/services/Endpoints/agents/title.js
@@ -66,7 +66,11 @@ const addTitle = async (req, { text, response, client }) => {
await titleCache.set(key, title, 120000);
await saveConvo(
- req,
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{
conversationId: response.conversationId,
title,
diff --git a/api/server/services/Endpoints/assistants/build.js b/api/server/services/Endpoints/assistants/build.js
index 00a2abf606..85f7090211 100644
--- a/api/server/services/Endpoints/assistants/build.js
+++ b/api/server/services/Endpoints/assistants/build.js
@@ -1,6 +1,6 @@
const { removeNullishValues } = require('librechat-data-provider');
const generateArtifactsPrompt = require('~/app/clients/prompts/artifacts');
-const { getAssistant } = require('~/models/Assistant');
+const { getAssistant } = require('~/models');
const buildOptions = async (endpoint, parsedBody) => {
const { promptPrefix, assistant_id, iconURL, greeting, spec, artifacts, ...modelOptions } =
diff --git a/api/server/services/Endpoints/assistants/title.js b/api/server/services/Endpoints/assistants/title.js
index 1fae68cf54..b31289eb60 100644
--- a/api/server/services/Endpoints/assistants/title.js
+++ b/api/server/services/Endpoints/assistants/title.js
@@ -1,9 +1,9 @@
const { isEnabled, sanitizeTitle } = require('@librechat/api');
const { logger } = require('@librechat/data-schemas');
const { CacheKeys } = require('librechat-data-provider');
-const { saveConvo } = require('~/models/Conversation');
const getLogStores = require('~/cache/getLogStores');
const initializeClient = require('./initalize');
+const { saveConvo } = require('~/models');
/**
* Generates a conversation title using OpenAI SDK
@@ -63,8 +63,13 @@ const addTitle = async (req, { text, responseText, conversationId }) => {
const title = await generateTitle({ openai, text, responseText });
await titleCache.set(key, title, 120000);
+ const reqCtx = {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ };
await saveConvo(
- req,
+ reqCtx,
{
conversationId,
title,
@@ -76,7 +81,11 @@ const addTitle = async (req, { text, responseText, conversationId }) => {
const fallbackTitle = text.length > 40 ? text.substring(0, 37) + '...' : text;
await titleCache.set(key, fallbackTitle, 120000);
await saveConvo(
- req,
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{
conversationId,
title: fallbackTitle,
diff --git a/api/server/services/Endpoints/azureAssistants/build.js b/api/server/services/Endpoints/azureAssistants/build.js
index 53b1dbeb68..315447ed7f 100644
--- a/api/server/services/Endpoints/azureAssistants/build.js
+++ b/api/server/services/Endpoints/azureAssistants/build.js
@@ -1,6 +1,6 @@
const { removeNullishValues } = require('librechat-data-provider');
const generateArtifactsPrompt = require('~/app/clients/prompts/artifacts');
-const { getAssistant } = require('~/models/Assistant');
+const { getAssistant } = require('~/models');
const buildOptions = async (endpoint, parsedBody) => {
const { promptPrefix, assistant_id, iconURL, greeting, spec, artifacts, ...modelOptions } =
diff --git a/api/server/services/Files/Audio/streamAudio.js b/api/server/services/Files/Audio/streamAudio.js
index a1d7c7a649..c28a96edff 100644
--- a/api/server/services/Files/Audio/streamAudio.js
+++ b/api/server/services/Files/Audio/streamAudio.js
@@ -5,8 +5,8 @@ const {
parseTextParts,
findLastSeparatorIndex,
} = require('librechat-data-provider');
-const { getMessage } = require('~/models/Message');
const { getLogStores } = require('~/cache');
+const { getMessage } = require('~/models');
/**
* @param {string[]} voiceIds - Array of voice IDs
diff --git a/api/server/services/Files/Audio/streamAudio.spec.js b/api/server/services/Files/Audio/streamAudio.spec.js
index e76c0849c7..977d8730aa 100644
--- a/api/server/services/Files/Audio/streamAudio.spec.js
+++ b/api/server/services/Files/Audio/streamAudio.spec.js
@@ -3,7 +3,7 @@ const { createChunkProcessor, splitTextIntoChunks } = require('./streamAudio');
jest.mock('keyv');
const globalCache = {};
-jest.mock('~/models/Message', () => {
+jest.mock('~/models', () => {
return {
getMessage: jest.fn().mockImplementation((messageId) => {
return globalCache[messageId] || null;
diff --git a/api/server/services/Files/Citations/index.js b/api/server/services/Files/Citations/index.js
index 7cb2ee6de0..008e21d7c4 100644
--- a/api/server/services/Files/Citations/index.js
+++ b/api/server/services/Files/Citations/index.js
@@ -8,8 +8,7 @@ const {
EModelEndpoint,
PermissionTypes,
} = require('librechat-data-provider');
-const { getRoleByName } = require('~/models/Role');
-const { Files } = require('~/models');
+const { getRoleByName, getFiles } = require('~/models');
/**
* Process file search results from tool calls
@@ -127,7 +126,7 @@ async function enhanceSourcesWithMetadata(sources, appConfig) {
let fileMetadataMap = {};
try {
- const files = await Files.find({ file_id: { $in: fileIds } });
+ const files = await getFiles({ file_id: { $in: fileIds } });
fileMetadataMap = files.reduce((map, file) => {
map[file.file_id] = file;
return map;
diff --git a/api/server/services/Files/permissions.js b/api/server/services/Files/permissions.js
index b9a5d6656f..ffa8e74799 100644
--- a/api/server/services/Files/permissions.js
+++ b/api/server/services/Files/permissions.js
@@ -1,7 +1,7 @@
const { logger } = require('@librechat/data-schemas');
const { PermissionBits, ResourceType, isEphemeralAgentId } = require('librechat-data-provider');
const { checkPermission } = require('~/server/services/PermissionService');
-const { getAgent } = require('~/models/Agent');
+const { getAgent } = require('~/models');
/**
* @param {Object} agent - The agent document (lean)
diff --git a/api/server/services/Files/process.js b/api/server/services/Files/process.js
index d01128927a..f7d7731975 100644
--- a/api/server/services/Files/process.js
+++ b/api/server/services/Files/process.js
@@ -27,16 +27,15 @@ const {
resizeImageBuffer,
} = require('~/server/services/Files/images');
const { addResourceFileId, deleteResourceFileId } = require('~/server/controllers/assistants/v2');
-const { addAgentResourceFile, removeAgentResourceFiles } = require('~/models/Agent');
const { getOpenAIClient } = require('~/server/controllers/assistants/helpers');
const { loadAuthValues } = require('~/server/services/Tools/credentials');
-const { createFile, updateFileUsage, deleteFiles } = require('~/models');
const { getFileStrategy } = require('~/server/utils/getFileStrategy');
const { checkCapability } = require('~/server/services/Config');
const { LB_QueueAsyncCall } = require('~/server/utils/queue');
const { getStrategyFunctions } = require('./strategies');
const { determineFileType } = require('~/server/utils');
const { STTService } = require('./Audio/STTService');
+const db = require('~/models');
/**
* Creates a modular file upload wrapper that ensures filename sanitization
@@ -211,7 +210,7 @@ const processDeleteRequest = async ({ req, files }) => {
if (agentFiles.length > 0) {
promises.push(
- removeAgentResourceFiles({
+ db.removeAgentResourceFiles({
agent_id: req.body.agent_id,
files: agentFiles,
}),
@@ -219,7 +218,7 @@ const processDeleteRequest = async ({ req, files }) => {
}
await Promise.allSettled(promises);
- await deleteFiles(resolvedFileIds);
+ await db.deleteFiles(resolvedFileIds);
};
/**
@@ -251,7 +250,7 @@ const processFileURL = async ({ fileStrategy, userId, URL, fileName, basePath, c
dimensions = {},
} = (await saveURL({ userId, URL, fileName, basePath })) || {};
const filepath = await getFileURL({ fileName: `${userId}/${fileName}`, basePath });
- return await createFile(
+ return await db.createFile(
{
user: userId,
file_id: v4(),
@@ -297,7 +296,7 @@ const processImageFile = async ({ req, res, metadata, returnFile = false }) => {
endpoint,
});
- const result = await createFile(
+ const result = await db.createFile(
{
user: req.user.id,
file_id,
@@ -349,7 +348,7 @@ const uploadImageBuffer = async ({ req, context, metadata = {}, resize = true })
}
const fileName = `${file_id}-${filename}`;
const filepath = await saveBuffer({ userId: req.user.id, fileName, buffer });
- return await createFile(
+ return await db.createFile(
{
user: req.user.id,
file_id,
@@ -435,7 +434,7 @@ const processFileUpload = async ({ req, res, metadata }) => {
filepath = result.filepath;
}
- const result = await createFile(
+ const result = await db.createFile(
{
user: req.user.id,
file_id: id ?? file_id,
@@ -545,14 +544,14 @@ const processAgentFileUpload = async ({ req, res, metadata }) => {
});
if (!messageAttachment && tool_resource) {
- await addAgentResourceFile({
- req,
+ await db.addAgentResourceFile({
file_id,
agent_id,
tool_resource,
+ updatingUserId: req?.user?.id,
});
}
- const result = await createFile(fileInfo, true);
+ const result = await db.createFile(fileInfo, true);
return res
.status(200)
.json({ message: 'Agent file uploaded and processed successfully', ...result });
@@ -685,11 +684,11 @@ const processAgentFileUpload = async ({ req, res, metadata }) => {
let filepath = _filepath;
if (!messageAttachment && tool_resource) {
- await addAgentResourceFile({
- req,
+ await db.addAgentResourceFile({
file_id,
agent_id,
tool_resource,
+ updatingUserId: req?.user?.id,
});
}
@@ -720,7 +719,7 @@ const processAgentFileUpload = async ({ req, res, metadata }) => {
width,
});
- const result = await createFile(fileInfo, true);
+ const result = await db.createFile(fileInfo, true);
res.status(200).json({ message: 'Agent file uploaded and processed successfully', ...result });
};
@@ -766,10 +765,10 @@ const processOpenAIFile = async ({
};
if (saveFile) {
- await createFile(file, true);
+ await db.createFile(file, true);
} else if (updateUsage) {
try {
- await updateFileUsage({ file_id });
+ await db.updateFileUsage({ file_id });
} catch (error) {
logger.error('Error updating file usage', error);
}
@@ -807,7 +806,7 @@ const processOpenAIImageOutput = async ({ req, buffer, file_id, filename, fileEx
file_id,
filename,
};
- createFile(file, true);
+ db.createFile(file, true);
return file;
};
@@ -951,7 +950,7 @@ async function saveBase64Image(
fileName: filename,
buffer: image.buffer,
});
- return await createFile(
+ return await db.createFile(
{
type,
source,
diff --git a/api/server/services/PermissionService.js b/api/server/services/PermissionService.js
index c82ee02599..f7b6be612f 100644
--- a/api/server/services/PermissionService.js
+++ b/api/server/services/PermissionService.js
@@ -20,16 +20,22 @@ const {
getEffectivePermissionsForResources: getEffectivePermissionsForResourcesACL,
grantPermission: grantPermissionACL,
findEntriesByPrincipalsAndResource,
+ findRolesByResourceType,
+ findPublicResourceIds,
+ bulkWriteAclEntries,
findGroupByExternalId,
findRoleByIdentifier,
+ deleteAclEntries,
getUserPrincipals,
+ findGroupByQuery,
+ updateGroupById,
+ bulkUpdateGroups,
hasPermission,
createGroup,
createUser,
updateUser,
findUser,
} = require('~/models');
-const { AclEntry, AccessRole, Group } = require('~/db/models');
/** @type {boolean|null} */
let transactionSupportCache = null;
@@ -280,17 +286,9 @@ const findPubliclyAccessibleResources = async ({ resourceType, requiredPermissio
validateResourceType(resourceType);
- // Find all public ACL entries where the public principal has at least the required permission bits
- const entries = await AclEntry.find({
- principalType: PrincipalType.PUBLIC,
- resourceType,
- permBits: { $bitsAllSet: requiredPermissions },
- }).distinct('resourceId');
-
- return entries;
+ return await findPublicResourceIds(resourceType, requiredPermissions);
} catch (error) {
logger.error(`[PermissionService.findPubliclyAccessibleResources] Error: ${error.message}`);
- // Re-throw validation errors
if (error.message.includes('requiredPermissions must be')) {
throw error;
}
@@ -307,7 +305,7 @@ const findPubliclyAccessibleResources = async ({ resourceType, requiredPermissio
const getAvailableRoles = async ({ resourceType }) => {
validateResourceType(resourceType);
- return await AccessRole.find({ resourceType }).lean();
+ return await findRolesByResourceType(resourceType);
};
/**
@@ -428,7 +426,7 @@ const ensureGroupPrincipalExists = async function (principal, authContext = null
let existingGroup = await findGroupByExternalId(principal.idOnTheSource, 'entra');
if (!existingGroup && principal.email) {
- existingGroup = await Group.findOne({ email: principal.email.toLowerCase() }).lean();
+ existingGroup = await findGroupByQuery({ email: principal.email.toLowerCase() });
}
if (existingGroup) {
@@ -457,7 +455,7 @@ const ensureGroupPrincipalExists = async function (principal, authContext = null
}
if (needsUpdate) {
- await Group.findByIdAndUpdate(existingGroup._id, { $set: updateData }, { new: true });
+ await updateGroupById(existingGroup._id, updateData);
}
return existingGroup._id.toString();
@@ -525,7 +523,7 @@ const syncUserEntraGroupMemberships = async (user, accessToken, session = null)
const sessionOptions = session ? { session } : {};
- await Group.updateMany(
+ await bulkUpdateGroups(
{
idOnTheSource: { $in: allGroupIds },
source: 'entra',
@@ -535,7 +533,7 @@ const syncUserEntraGroupMemberships = async (user, accessToken, session = null)
sessionOptions,
);
- await Group.updateMany(
+ await bulkUpdateGroups(
{
source: 'entra',
memberIds: user.idOnTheSource,
@@ -633,7 +631,7 @@ const bulkUpdateResourcePermissions = async ({
const sessionOptions = localSession ? { session: localSession } : {};
- const roles = await AccessRole.find({ resourceType }).lean();
+ const roles = await findRolesByResourceType(resourceType);
const rolesMap = new Map();
roles.forEach((role) => {
rolesMap.set(role.accessRoleId, role);
@@ -737,7 +735,7 @@ const bulkUpdateResourcePermissions = async ({
}
if (bulkWrites.length > 0) {
- await AclEntry.bulkWrite(bulkWrites, sessionOptions);
+ await bulkWriteAclEntries(bulkWrites, sessionOptions);
}
const deleteQueries = [];
@@ -778,12 +776,7 @@ const bulkUpdateResourcePermissions = async ({
}
if (deleteQueries.length > 0) {
- await AclEntry.deleteMany(
- {
- $or: deleteQueries,
- },
- sessionOptions,
- );
+ await deleteAclEntries({ $or: deleteQueries }, sessionOptions);
}
if (shouldEndSession && supportsTransactions) {
@@ -870,7 +863,7 @@ const removeAllPermissions = async ({ resourceType, resourceId }) => {
throw new Error(`Invalid resource ID: ${resourceId}`);
}
- const result = await AclEntry.deleteMany({
+ const result = await deleteAclEntries({
resourceType,
resourceId,
});
diff --git a/api/server/services/Threads/manage.js b/api/server/services/Threads/manage.js
index 627dba1a35..27520f38a5 100644
--- a/api/server/services/Threads/manage.js
+++ b/api/server/services/Threads/manage.js
@@ -1,16 +1,15 @@
const path = require('path');
const { v4 } = require('uuid');
-const { countTokens, escapeRegExp } = require('@librechat/api');
+const { countTokens } = require('@librechat/api');
+const { escapeRegExp } = require('@librechat/data-schemas');
const {
Constants,
ContentTypes,
AnnotationTypes,
defaultOrderQuery,
} = require('librechat-data-provider');
+const { recordMessage, getMessages, spendTokens, saveConvo } = require('~/models');
const { retrieveAndProcessFile } = require('~/server/services/Files/process');
-const { recordMessage, getMessages } = require('~/models/Message');
-const { spendTokens } = require('~/models/spendTokens');
-const { saveConvo } = require('~/models/Conversation');
/**
* Initializes a new thread or adds messages to an existing thread.
@@ -62,24 +61,6 @@ async function initThread({ openai, body, thread_id: _thread_id }) {
async function saveUserMessage(req, params) {
const tokenCount = await countTokens(params.text);
- // todo: do this on the frontend
- // const { file_ids = [] } = params;
- // let content;
- // if (file_ids.length) {
- // content = [
- // {
- // value: params.text,
- // },
- // ...(
- // file_ids
- // .filter(f => f)
- // .map((file_id) => ({
- // file_id,
- // }))
- // ),
- // ];
- // }
-
const userMessage = {
user: params.user,
endpoint: params.endpoint,
@@ -110,9 +91,15 @@ async function saveUserMessage(req, params) {
}
const message = await recordMessage(userMessage);
- await saveConvo(req, convo, {
- context: 'api/server/services/Threads/manage.js #saveUserMessage',
- });
+ await saveConvo(
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
+ convo,
+ { context: 'api/server/services/Threads/manage.js #saveUserMessage' },
+ );
return message;
}
@@ -161,7 +148,11 @@ async function saveAssistantMessage(req, params) {
});
await saveConvo(
- req,
+ {
+ userId: req?.user?.id,
+ isTemporary: req?.body?.isTemporary,
+ interfaceConfig: req?.config?.interfaceConfig,
+ },
{
endpoint: params.endpoint,
conversationId: params.conversationId,
@@ -353,7 +344,11 @@ async function syncMessages({
await Promise.all(recordPromises);
await saveConvo(
- openai.req,
+ {
+ userId: openai.req?.user?.id,
+ isTemporary: openai.req?.body?.isTemporary,
+ interfaceConfig: openai.req?.config?.interfaceConfig,
+ },
{
conversationId,
file_ids: attached_file_ids,
diff --git a/api/server/services/cleanup.js b/api/server/services/cleanup.js
index 7d3dfdec12..dc4f62c2ac 100644
--- a/api/server/services/cleanup.js
+++ b/api/server/services/cleanup.js
@@ -1,5 +1,5 @@
const { logger } = require('@librechat/data-schemas');
-const { deleteNullOrEmptyConversations } = require('~/models/Conversation');
+const { deleteNullOrEmptyConversations } = require('~/models');
const cleanup = async () => {
try {
diff --git a/api/server/services/start/migration.js b/api/server/services/start/migration.js
index ab8d32b714..70f8300e08 100644
--- a/api/server/services/start/migration.js
+++ b/api/server/services/start/migration.js
@@ -6,7 +6,6 @@ const {
checkAgentPermissionsMigration,
checkPromptPermissionsMigration,
} = require('@librechat/api');
-const { Agent, PromptGroup } = require('~/db/models');
const { findRoleByIdentifier } = require('~/models');
/**
@@ -20,7 +19,7 @@ async function checkMigrations() {
methods: {
findRoleByIdentifier,
},
- AgentModel: Agent,
+ AgentModel: mongoose.models.Agent,
});
logAgentMigrationWarning(agentMigrationResult);
} catch (error) {
@@ -32,7 +31,7 @@ async function checkMigrations() {
methods: {
findRoleByIdentifier,
},
- PromptGroupModel: PromptGroup,
+ PromptGroupModel: mongoose.models.PromptGroup,
});
logPromptMigrationWarning(promptMigrationResult);
} catch (error) {
diff --git a/api/server/utils/import/fork.js b/api/server/utils/import/fork.js
index f896de378c..5df4d27af2 100644
--- a/api/server/utils/import/fork.js
+++ b/api/server/utils/import/fork.js
@@ -3,8 +3,7 @@ const { logger } = require('@librechat/data-schemas');
const { EModelEndpoint, Constants, ForkOptions } = require('librechat-data-provider');
const { createImportBatchBuilder } = require('./importBatchBuilder');
const BaseClient = require('~/app/clients/BaseClient');
-const { getConvo } = require('~/models/Conversation');
-const { getMessages } = require('~/models/Message');
+const { getConvo, getMessages } = require('~/models');
/**
* Helper function to clone messages with proper parent-child relationships and timestamps
diff --git a/api/server/utils/import/fork.spec.js b/api/server/utils/import/fork.spec.js
index 552620dc89..6fd108674a 100644
--- a/api/server/utils/import/fork.spec.js
+++ b/api/server/utils/import/fork.spec.js
@@ -1,16 +1,10 @@
const { Constants, ForkOptions } = require('librechat-data-provider');
-jest.mock('~/models/Conversation', () => ({
+jest.mock('~/models', () => ({
getConvo: jest.fn(),
bulkSaveConvos: jest.fn(),
-}));
-
-jest.mock('~/models/Message', () => ({
getMessages: jest.fn(),
bulkSaveMessages: jest.fn(),
-}));
-
-jest.mock('~/models/ConversationTag', () => ({
bulkIncrementTagCounts: jest.fn(),
}));
@@ -32,9 +26,13 @@ const {
getMessagesUpToTargetLevel,
cloneMessagesWithTimestamps,
} = require('./fork');
-const { bulkIncrementTagCounts } = require('~/models/ConversationTag');
-const { getConvo, bulkSaveConvos } = require('~/models/Conversation');
-const { getMessages, bulkSaveMessages } = require('~/models/Message');
+const {
+ bulkIncrementTagCounts,
+ getConvo,
+ bulkSaveConvos,
+ getMessages,
+ bulkSaveMessages,
+} = require('~/models');
const { createImportBatchBuilder } = require('./importBatchBuilder');
const BaseClient = require('~/app/clients/BaseClient');
diff --git a/api/server/utils/import/importBatchBuilder.js b/api/server/utils/import/importBatchBuilder.js
index 5e499043d2..29fbfa85a2 100644
--- a/api/server/utils/import/importBatchBuilder.js
+++ b/api/server/utils/import/importBatchBuilder.js
@@ -1,9 +1,7 @@
const { v4: uuidv4 } = require('uuid');
const { logger } = require('@librechat/data-schemas');
const { EModelEndpoint, Constants, openAISettings } = require('librechat-data-provider');
-const { bulkIncrementTagCounts } = require('~/models/ConversationTag');
-const { bulkSaveConvos } = require('~/models/Conversation');
-const { bulkSaveMessages } = require('~/models/Message');
+const { bulkIncrementTagCounts, bulkSaveConvos, bulkSaveMessages } = require('~/models');
/**
* Factory function for creating an instance of ImportBatchBuilder.
diff --git a/api/server/utils/import/importers-timestamp.spec.js b/api/server/utils/import/importers-timestamp.spec.js
index 02f24f72ae..09021a9ccd 100644
--- a/api/server/utils/import/importers-timestamp.spec.js
+++ b/api/server/utils/import/importers-timestamp.spec.js
@@ -4,10 +4,8 @@ const { ImportBatchBuilder } = require('./importBatchBuilder');
const { getImporter } = require('./importers');
// Mock the database methods
-jest.mock('~/models/Conversation', () => ({
+jest.mock('~/models', () => ({
bulkSaveConvos: jest.fn(),
-}));
-jest.mock('~/models/Message', () => ({
bulkSaveMessages: jest.fn(),
}));
jest.mock('~/cache/getLogStores');
diff --git a/api/server/utils/import/importers.spec.js b/api/server/utils/import/importers.spec.js
index 2ddfa76658..7984144cbc 100644
--- a/api/server/utils/import/importers.spec.js
+++ b/api/server/utils/import/importers.spec.js
@@ -1,10 +1,9 @@
const fs = require('fs');
const path = require('path');
const { EModelEndpoint, Constants, openAISettings } = require('librechat-data-provider');
-const { bulkSaveConvos: _bulkSaveConvos } = require('~/models/Conversation');
const { getImporter, processAssistantMessage } = require('./importers');
const { ImportBatchBuilder } = require('./importBatchBuilder');
-const { bulkSaveMessages } = require('~/models/Message');
+const { bulkSaveMessages, bulkSaveConvos: _bulkSaveConvos } = require('~/models');
const getLogStores = require('~/cache/getLogStores');
jest.mock('~/cache/getLogStores');
@@ -14,10 +13,8 @@ getLogStores.mockImplementation(() => ({
}));
// Mock the database methods
-jest.mock('~/models/Conversation', () => ({
+jest.mock('~/models', () => ({
bulkSaveConvos: jest.fn(),
-}));
-jest.mock('~/models/Message', () => ({
bulkSaveMessages: jest.fn(),
}));
diff --git a/api/strategies/localStrategy.js b/api/strategies/localStrategy.js
index 0d220ead25..5d725c0907 100644
--- a/api/strategies/localStrategy.js
+++ b/api/strategies/localStrategy.js
@@ -1,8 +1,9 @@
+const bcrypt = require('bcryptjs');
const { logger } = require('@librechat/data-schemas');
const { errorsToString } = require('librechat-data-provider');
-const { isEnabled, checkEmailConfig } = require('@librechat/api');
const { Strategy: PassportLocalStrategy } = require('passport-local');
-const { findUser, comparePassword, updateUser } = require('~/models');
+const { isEnabled, checkEmailConfig, comparePassword } = require('@librechat/api');
+const { findUser, updateUser } = require('~/models');
const { loginSchema } = require('./validators');
// Unix timestamp for 2024-06-07 15:20:18 Eastern Time
@@ -35,7 +36,7 @@ async function passportLogin(req, email, password, done) {
return done(null, false, { message: 'Email does not exist.' });
}
- const isMatch = await comparePassword(user, password);
+ const isMatch = await comparePassword(user, password, { compare: bcrypt.compare });
if (!isMatch) {
logError('Passport Local Strategy - Password does not match', { isMatch });
logger.error(`[Login] [Login failed] [Username: ${email}] [Request-IP: ${req.ip}]`);
diff --git a/api/test/services/Files/processFileCitations.test.js b/api/test/services/Files/processFileCitations.test.js
index e9fe850ebd..8dd588afe9 100644
--- a/api/test/services/Files/processFileCitations.test.js
+++ b/api/test/services/Files/processFileCitations.test.js
@@ -7,12 +7,7 @@ const {
// Mock dependencies
jest.mock('~/models', () => ({
- Files: {
- find: jest.fn().mockResolvedValue([]),
- },
-}));
-
-jest.mock('~/models/Role', () => ({
+ getFiles: jest.fn().mockResolvedValue([]),
getRoleByName: jest.fn(),
}));
@@ -179,7 +174,7 @@ describe('processFileCitations', () => {
});
describe('enhanceSourcesWithMetadata', () => {
- const { Files } = require('~/models');
+ const { getFiles } = require('~/models');
const mockCustomConfig = {
fileStrategy: 'local',
};
@@ -204,7 +199,7 @@ describe('processFileCitations', () => {
},
];
- Files.find.mockResolvedValue([
+ getFiles.mockResolvedValue([
{
file_id: 'file_123',
filename: 'example_from_db.pdf',
@@ -219,7 +214,7 @@ describe('processFileCitations', () => {
const result = await enhanceSourcesWithMetadata(sources, mockCustomConfig);
- expect(Files.find).toHaveBeenCalledWith({ file_id: { $in: ['file_123', 'file_456'] } });
+ expect(getFiles).toHaveBeenCalledWith({ file_id: { $in: ['file_123', 'file_456'] } });
expect(result).toHaveLength(2);
expect(result[0]).toEqual({
@@ -258,7 +253,7 @@ describe('processFileCitations', () => {
},
];
- Files.find.mockResolvedValue([
+ getFiles.mockResolvedValue([
{
file_id: 'file_123',
filename: 'example_from_db.pdf',
@@ -292,7 +287,7 @@ describe('processFileCitations', () => {
},
];
- Files.find.mockResolvedValue([]);
+ getFiles.mockResolvedValue([]);
const result = await enhanceSourcesWithMetadata(sources, mockCustomConfig);
@@ -317,7 +312,7 @@ describe('processFileCitations', () => {
},
];
- Files.find.mockRejectedValue(new Error('Database error'));
+ getFiles.mockRejectedValue(new Error('Database error'));
const result = await enhanceSourcesWithMetadata(sources, mockCustomConfig);
@@ -339,14 +334,14 @@ describe('processFileCitations', () => {
{ fileId: 'file_456', fileName: 'doc2.pdf', relevance: 0.7, type: 'file' },
];
- Files.find.mockResolvedValue([
+ getFiles.mockResolvedValue([
{ file_id: 'file_123', filename: 'document1.pdf', source: 's3' },
{ file_id: 'file_456', filename: 'document2.pdf', source: 'local' },
]);
await enhanceSourcesWithMetadata(sources, mockCustomConfig);
- expect(Files.find).toHaveBeenCalledWith({ file_id: { $in: ['file_123', 'file_456'] } });
+ expect(getFiles).toHaveBeenCalledWith({ file_id: { $in: ['file_123', 'file_456'] } });
});
});
});
diff --git a/api/models/PromptGroupMigration.spec.js b/config/__tests__/migrate-prompt-permissions.spec.js
similarity index 98%
rename from api/models/PromptGroupMigration.spec.js
rename to config/__tests__/migrate-prompt-permissions.spec.js
index 04ff612e7d..2d5b2cb4b0 100644
--- a/api/models/PromptGroupMigration.spec.js
+++ b/config/__tests__/migrate-prompt-permissions.spec.js
@@ -11,7 +11,7 @@ const {
} = require('librechat-data-provider');
// Mock the config/connect module to prevent connection attempts during tests
-jest.mock('../../config/connect', () => jest.fn().mockResolvedValue(true));
+jest.mock('../connect', () => jest.fn().mockResolvedValue(true));
// Disable console for tests
logger.silent = true;
@@ -78,7 +78,7 @@ describe('PromptGroup Migration Script', () => {
});
// Import migration function
- const migration = require('../../config/migrate-prompt-permissions');
+ const migration = require('../migrate-prompt-permissions');
migrateToPromptGroupPermissions = migration.migrateToPromptGroupPermissions;
});
diff --git a/config/add-balance.js b/config/add-balance.js
index 0f86abb556..25de4c52e2 100644
--- a/config/add-balance.js
+++ b/config/add-balance.js
@@ -3,9 +3,9 @@ const mongoose = require('mongoose');
const { getBalanceConfig } = require('@librechat/api');
const { User } = require('@librechat/data-schemas').createModels(mongoose);
require('module-alias')({ base: path.resolve(__dirname, '..', 'api') });
-const { createTransaction } = require('~/models/Transaction');
const { getAppConfig } = require('~/server/services/Config');
const { askQuestion, silentExit } = require('./helpers');
+const { createTransaction } = require('~/models');
const connect = require('./connect');
(async () => {
diff --git a/eslint.config.mjs b/eslint.config.mjs
index bd848c7e3e..1dde65cda1 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -355,5 +355,16 @@ export default [
project: './packages/data-schemas/tsconfig.json',
},
},
+ rules: {
+ '@typescript-eslint/no-unused-vars': [
+ 'warn',
+ {
+ argsIgnorePattern: '^_',
+ varsIgnorePattern: '^_',
+ caughtErrorsIgnorePattern: '^_',
+ destructuredArrayIgnorePattern: '^_',
+ },
+ ],
+ },
},
];
diff --git a/packages/api/src/agents/__tests__/load.spec.ts b/packages/api/src/agents/__tests__/load.spec.ts
new file mode 100644
index 0000000000..b7c6142d69
--- /dev/null
+++ b/packages/api/src/agents/__tests__/load.spec.ts
@@ -0,0 +1,397 @@
+import mongoose from 'mongoose';
+import { v4 as uuidv4 } from 'uuid';
+import { Constants } from 'librechat-data-provider';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import { agentSchema, createMethods } from '@librechat/data-schemas';
+import type { AgentModelParameters } from 'librechat-data-provider';
+import type { LoadAgentParams, LoadAgentDeps } from '../load';
+import { loadAgent } from '../load';
+
+let Agent: mongoose.Model<unknown>;
+let createAgent: ReturnType<typeof createMethods>['createAgent'];
+let getAgent: ReturnType<typeof createMethods>['getAgent'];
+
+const mockGetMCPServerTools = jest.fn();
+
+const deps: LoadAgentDeps = {
+ getAgent: (searchParameter) => getAgent(searchParameter),
+ getMCPServerTools: mockGetMCPServerTools,
+};
+
+describe('loadAgent', () => {
+ let mongoServer: MongoMemoryServer;
+
+ beforeAll(async () => {
+ mongoServer = await MongoMemoryServer.create();
+ const mongoUri = mongoServer.getUri();
+ Agent = mongoose.models.Agent || mongoose.model('Agent', agentSchema);
+ await mongoose.connect(mongoUri);
+ const methods = createMethods(mongoose);
+ createAgent = methods.createAgent;
+ getAgent = methods.getAgent;
+ }, 20000);
+
+ afterAll(async () => {
+ await mongoose.disconnect();
+ await mongoServer.stop();
+ });
+
+ beforeEach(async () => {
+ await Agent.deleteMany({});
+ jest.clearAllMocks();
+ });
+
+ test('should return null when agent_id is not provided', async () => {
+ const mockReq = { user: { id: 'user123' } };
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: null as unknown as string,
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ expect(result).toBeNull();
+ });
+
+ test('should return null when agent_id is empty string', async () => {
+ const mockReq = { user: { id: 'user123' } };
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: '',
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ expect(result).toBeNull();
+ });
+
+ test('should test ephemeral agent loading logic', async () => {
+ const { EPHEMERAL_AGENT_ID } = Constants;
+
+ // Mock getMCPServerTools to return tools for each server
+ mockGetMCPServerTools.mockImplementation(async (_userId: string, server: string) => {
+ if (server === 'server1') {
+ return { tool1_mcp_server1: {} };
+ } else if (server === 'server2') {
+ return { tool2_mcp_server2: {} };
+ }
+ return null;
+ });
+
+ const mockReq = {
+ user: { id: 'user123' },
+ body: {
+ promptPrefix: 'Test instructions',
+ ephemeralAgent: {
+ execute_code: true,
+ web_search: true,
+ mcp: ['server1', 'server2'],
+ },
+ },
+ };
+
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: EPHEMERAL_AGENT_ID as string,
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4', temperature: 0.7 } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ if (result) {
+ // Ephemeral agent ID is encoded with endpoint and model
+ expect(result.id).toBe('openai__gpt-4');
+ expect(result.instructions).toBe('Test instructions');
+ expect(result.provider).toBe('openai');
+ expect(result.model).toBe('gpt-4');
+ expect(result.model_parameters.temperature).toBe(0.7);
+ expect(result.tools).toContain('execute_code');
+ expect(result.tools).toContain('web_search');
+ expect(result.tools).toContain('tool1_mcp_server1');
+ expect(result.tools).toContain('tool2_mcp_server2');
+ } else {
+ expect(result).toBeNull();
+ }
+ });
+
+ test('should return null for non-existent agent', async () => {
+ const mockReq = { user: { id: 'user123' } };
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: 'agent_non_existent',
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ expect(result).toBeNull();
+ });
+
+ test('should load agent when user is the author', async () => {
+ const userId = new mongoose.Types.ObjectId();
+ const agentId = `agent_${uuidv4()}`;
+
+ await createAgent({
+ id: agentId,
+ name: 'Test Agent',
+ provider: 'openai',
+ model: 'gpt-4',
+ author: userId,
+ description: 'Test description',
+ tools: ['web_search'],
+ });
+
+ const mockReq = { user: { id: userId.toString() } };
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: agentId,
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ expect(result).toBeDefined();
+ expect(result!.id).toBe(agentId);
+ expect(result!.name).toBe('Test Agent');
+ expect(String(result!.author)).toBe(userId.toString());
+ expect(result!.version).toBe(1);
+ });
+
+ test('should return agent even when user is not author (permissions checked at route level)', async () => {
+ const authorId = new mongoose.Types.ObjectId();
+ const userId = new mongoose.Types.ObjectId();
+ const agentId = `agent_${uuidv4()}`;
+
+ await createAgent({
+ id: agentId,
+ name: 'Test Agent',
+ provider: 'openai',
+ model: 'gpt-4',
+ author: authorId,
+ });
+
+ const mockReq = { user: { id: userId.toString() } };
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: agentId,
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ // With the new permission system, loadAgent returns the agent regardless of permissions
+ // Permission checks are handled at the route level via middleware
+ expect(result).toBeTruthy();
+ expect(result!.id).toBe(agentId);
+ expect(result!.name).toBe('Test Agent');
+ });
+
+ test('should handle ephemeral agent with no MCP servers', async () => {
+ const { EPHEMERAL_AGENT_ID } = Constants;
+
+ const mockReq = {
+ user: { id: 'user123' },
+ body: {
+ promptPrefix: 'Simple instructions',
+ ephemeralAgent: {
+ execute_code: false,
+ web_search: false,
+ mcp: [],
+ },
+ },
+ };
+
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: EPHEMERAL_AGENT_ID as string,
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-3.5-turbo' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ if (result) {
+ expect(result.tools).toEqual([]);
+ expect(result.instructions).toBe('Simple instructions');
+ } else {
+ expect(result).toBeFalsy();
+ }
+ });
+
+ test('should handle ephemeral agent with undefined ephemeralAgent in body', async () => {
+ const { EPHEMERAL_AGENT_ID } = Constants;
+
+ const mockReq = {
+ user: { id: 'user123' },
+ body: {
+ promptPrefix: 'Basic instructions',
+ },
+ };
+
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: EPHEMERAL_AGENT_ID as string,
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ if (result) {
+ expect(result.tools).toEqual([]);
+ } else {
+ expect(result).toBeFalsy();
+ }
+ });
+
+ describe('Edge Cases', () => {
+ test('should handle loadAgent with malformed req object', async () => {
+ const result = await loadAgent(
+ {
+ req: null as unknown as LoadAgentParams['req'],
+ agent_id: 'agent_test',
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ expect(result).toBeNull();
+ });
+
+ test('should handle ephemeral agent with extremely large tool list', async () => {
+ const { EPHEMERAL_AGENT_ID } = Constants;
+
+ const largeToolList = Array.from({ length: 100 }, (_, i) => `tool_${i}_mcp_server1`);
+ const availableTools: Record<string, object> = {};
+ for (const tool of largeToolList) {
+ availableTools[tool] = {};
+ }
+
+ // Mock getMCPServerTools to return all tools for server1
+ mockGetMCPServerTools.mockImplementation(async (_userId: string, server: string) => {
+ if (server === 'server1') {
+ return availableTools; // All 100 tools belong to server1
+ }
+ return null;
+ });
+
+ const mockReq = {
+ user: { id: 'user123' },
+ body: {
+ promptPrefix: 'Test',
+ ephemeralAgent: {
+ execute_code: true,
+ web_search: true,
+ mcp: ['server1'],
+ },
+ },
+ };
+
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: EPHEMERAL_AGENT_ID as string,
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ if (result) {
+ expect(result.tools!.length).toBeGreaterThan(100);
+ }
+ });
+
+ test('should return agent from different project (permissions checked at route level)', async () => {
+ const authorId = new mongoose.Types.ObjectId();
+ const userId = new mongoose.Types.ObjectId();
+ const agentId = `agent_${uuidv4()}`;
+
+ await createAgent({
+ id: agentId,
+ name: 'Project Agent',
+ provider: 'openai',
+ model: 'gpt-4',
+ author: authorId,
+ });
+
+ const mockReq = { user: { id: userId.toString() } };
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: agentId,
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ // With the new permission system, loadAgent returns the agent regardless of permissions
+ // Permission checks are handled at the route level via middleware
+ expect(result).toBeTruthy();
+ expect(result!.id).toBe(agentId);
+ expect(result!.name).toBe('Project Agent');
+ });
+
+ test('should handle loadEphemeralAgent with malformed MCP tool names', async () => {
+ const { EPHEMERAL_AGENT_ID } = Constants;
+
+ // Mock getMCPServerTools to return only tools matching the server
+ mockGetMCPServerTools.mockImplementation(async (_userId: string, server: string) => {
+ if (server === 'server1') {
+ // Only return tool that correctly matches server1 format
+ return { tool_mcp_server1: {} };
+ } else if (server === 'server2') {
+ return { tool_mcp_server2: {} };
+ }
+ return null;
+ });
+
+ const mockReq = {
+ user: { id: 'user123' },
+ body: {
+ promptPrefix: 'Test instructions',
+ ephemeralAgent: {
+ execute_code: false,
+ web_search: false,
+ mcp: ['server1'],
+ },
+ },
+ };
+
+ const result = await loadAgent(
+ {
+ req: mockReq,
+ agent_id: EPHEMERAL_AGENT_ID as string,
+ endpoint: 'openai',
+ model_parameters: { model: 'gpt-4' } as unknown as AgentModelParameters,
+ },
+ deps,
+ );
+
+ if (result) {
+ expect(result.tools).toEqual(['tool_mcp_server1']);
+ expect(result.tools).not.toContain('malformed_tool_name');
+ expect(result.tools).not.toContain('tool__server1');
+ expect(result.tools).not.toContain('tool_mcp_server2');
+ }
+ });
+ });
+});
diff --git a/packages/api/src/agents/added.ts b/packages/api/src/agents/added.ts
new file mode 100644
index 0000000000..587f3bc437
--- /dev/null
+++ b/packages/api/src/agents/added.ts
@@ -0,0 +1,230 @@
+import { logger } from '@librechat/data-schemas';
+import type { AppConfig } from '@librechat/data-schemas';
+import {
+ Tools,
+ Constants,
+ isAgentsEndpoint,
+ isEphemeralAgentId,
+ appendAgentIdSuffix,
+ encodeEphemeralAgentId,
+} from 'librechat-data-provider';
+import type { Agent, TConversation } from 'librechat-data-provider';
+import { getCustomEndpointConfig } from '~/app/config';
+
+const { mcp_all, mcp_delimiter } = Constants;
+
+export const ADDED_AGENT_ID = 'added_agent';
+
+export interface LoadAddedAgentDeps {
+ getAgent: (searchParameter: { id: string }) => Promise<Agent | null>;
+ getMCPServerTools: (
+ userId: string,
+ serverName: string,
+ ) => Promise<Record<string, unknown> | null>;
+}
+
+interface LoadAddedAgentParams {
+ req: { user?: { id?: string }; config?: Record<string, unknown> };
+ conversation: TConversation | null;
+ primaryAgent?: Agent | null;
+}
+
+/**
+ * Loads an agent from an added conversation (for multi-convo parallel agent execution).
+ * Returns the agent config as a plain object, or null if invalid.
+ */
+export async function loadAddedAgent(
+ { req, conversation, primaryAgent }: LoadAddedAgentParams,
+ deps: LoadAddedAgentDeps,
+): Promise<Agent | null> {
+ if (!conversation) {
+ return null;
+ }
+
+ if (conversation.agent_id && !isEphemeralAgentId(conversation.agent_id)) {
+ const reqRecord = req as Record<string, unknown>;
+ let agent = reqRecord.resolvedAddedAgent as Agent | null | undefined;
+ if (!agent) {
+ agent = await deps.getAgent({ id: conversation.agent_id });
+ }
+ if (!agent) {
+ logger.warn(`[loadAddedAgent] Agent ${conversation.agent_id} not found`);
+ return null;
+ }
+
+ const agentRecord = agent as Record<string, unknown>;
+ const versions = agentRecord.versions as unknown[] | undefined;
+ agentRecord.version = versions ? versions.length : 0;
+ agent.id = appendAgentIdSuffix(agent.id, 1);
+ return agent;
+ }
+
+ const { model, endpoint, promptPrefix, spec, ...rest } = conversation as TConversation & {
+ promptPrefix?: string;
+ spec?: string;
+ modelLabel?: string;
+ ephemeralAgent?: {
+ mcp?: string[];
+ execute_code?: boolean;
+ file_search?: boolean;
+ web_search?: boolean;
+ artifacts?: unknown;
+ };
+ [key: string]: unknown;
+ };
+
+ if (!endpoint || !model) {
+ logger.warn('[loadAddedAgent] Missing required endpoint or model for ephemeral agent');
+ return null;
+ }
+
+ const appConfig = req.config as AppConfig | undefined;
+
+ const primaryIsEphemeral = primaryAgent && isEphemeralAgentId(primaryAgent.id);
+ if (primaryIsEphemeral && Array.isArray(primaryAgent.tools)) {
+ let endpointConfig = (appConfig?.endpoints as Record<string, unknown> | undefined)?.[
+ endpoint
+ ] as Record<string, unknown> | undefined;
+ if (!isAgentsEndpoint(endpoint) && !endpointConfig) {
+ try {
+ endpointConfig = getCustomEndpointConfig({ endpoint, appConfig }) as
+ | Record<string, unknown>
+ | undefined;
+ } catch (err) {
+ logger.error('[loadAddedAgent] Error getting custom endpoint config', err);
+ }
+ }
+
+ const modelSpecs = (appConfig?.modelSpecs as { list?: Array<{ name: string; label?: string }> })
+ ?.list;
+ const modelSpec = spec != null && spec !== '' ? modelSpecs?.find((s) => s.name === spec) : null;
+ const sender =
+ rest.modelLabel ??
+ modelSpec?.label ??
+ (endpointConfig?.modelDisplayLabel as string | undefined) ??
+ '';
+ const ephemeralId = encodeEphemeralAgentId({ endpoint, model, sender, index: 1 });
+
+ return {
+ id: ephemeralId,
+ instructions: promptPrefix || '',
+ provider: endpoint,
+ model_parameters: {},
+ model,
+ tools: [...primaryAgent.tools],
+ } as unknown as Agent;
+ }
+
+ const ephemeralAgent = rest.ephemeralAgent as
+ | {
+ mcp?: string[];
+ execute_code?: boolean;
+ file_search?: boolean;
+ web_search?: boolean;
+ artifacts?: unknown;
+ }
+ | undefined;
+ const mcpServers = new Set<string>(ephemeralAgent?.mcp);
+ const userId = req.user?.id ?? '';
+
+ const modelSpecs = (
+ appConfig?.modelSpecs as {
+ list?: Array<{
+ name: string;
+ label?: string;
+ mcpServers?: string[];
+ executeCode?: boolean;
+ fileSearch?: boolean;
+ webSearch?: boolean;
+ }>;
+ }
+ )?.list;
+ let modelSpec: (typeof modelSpecs extends Array<infer T> | undefined ? T : never) | null = null;
+ if (spec != null && spec !== '') {
+ modelSpec = modelSpecs?.find((s) => s.name === spec) ?? null;
+ }
+ if (modelSpec?.mcpServers) {
+ for (const mcpServer of modelSpec.mcpServers) {
+ mcpServers.add(mcpServer);
+ }
+ }
+
+ const tools: string[] = [];
+ if (ephemeralAgent?.execute_code === true || modelSpec?.executeCode === true) {
+ tools.push(Tools.execute_code);
+ }
+ if (ephemeralAgent?.file_search === true || modelSpec?.fileSearch === true) {
+ tools.push(Tools.file_search);
+ }
+ if (ephemeralAgent?.web_search === true || modelSpec?.webSearch === true) {
+ tools.push(Tools.web_search);
+ }
+
+ const addedServers = new Set<string>();
+ for (const mcpServer of mcpServers) {
+ if (addedServers.has(mcpServer)) {
+ continue;
+ }
+ const serverTools = await deps.getMCPServerTools(userId, mcpServer);
+ if (!serverTools) {
+ tools.push(`${mcp_all}${mcp_delimiter}${mcpServer}`);
+ addedServers.add(mcpServer);
+ continue;
+ }
+ tools.push(...Object.keys(serverTools));
+ addedServers.add(mcpServer);
+ }
+
+ const model_parameters: Record<string, unknown> = {};
+ const paramKeys = [
+ 'temperature',
+ 'top_p',
+ 'topP',
+ 'topK',
+ 'presence_penalty',
+ 'frequency_penalty',
+ 'maxOutputTokens',
+ 'maxTokens',
+ 'max_tokens',
+ ];
+ for (const key of paramKeys) {
+ if ((rest as Record<string, unknown>)[key] != null) {
+ model_parameters[key] = (rest as Record<string, unknown>)[key];
+ }
+ }
+
+ let endpointConfig = (appConfig?.endpoints as Record<string, unknown> | undefined)?.[endpoint] as
+ | Record<string, unknown>
+ | undefined;
+ if (!isAgentsEndpoint(endpoint) && !endpointConfig) {
+ try {
+ endpointConfig = getCustomEndpointConfig({ endpoint, appConfig }) as
+ | Record<string, unknown>
+ | undefined;
+ } catch (err) {
+ logger.error('[loadAddedAgent] Error getting custom endpoint config', err);
+ }
+ }
+
+ const sender =
+ rest.modelLabel ??
+ modelSpec?.label ??
+ (endpointConfig?.modelDisplayLabel as string | undefined) ??
+ '';
+ const ephemeralId = encodeEphemeralAgentId({ endpoint, model, sender, index: 1 });
+
+ const result: Record<string, unknown> = {
+ id: ephemeralId,
+ instructions: promptPrefix || '',
+ provider: endpoint,
+ model_parameters,
+ model,
+ tools,
+ };
+
+ if (ephemeralAgent?.artifacts != null && ephemeralAgent.artifacts) {
+ result.artifacts = ephemeralAgent.artifacts;
+ }
+
+ return result as unknown as Agent;
+}
diff --git a/packages/api/src/agents/index.ts b/packages/api/src/agents/index.ts
index 47e15b8c28..ffb8cec332 100644
--- a/packages/api/src/agents/index.ts
+++ b/packages/api/src/agents/index.ts
@@ -16,3 +16,5 @@ export * from './responses';
export * from './run';
export * from './tools';
export * from './validation';
+export * from './added';
+export * from './load';
diff --git a/packages/api/src/agents/load.ts b/packages/api/src/agents/load.ts
new file mode 100644
index 0000000000..05746d1195
--- /dev/null
+++ b/packages/api/src/agents/load.ts
@@ -0,0 +1,162 @@
+import { logger } from '@librechat/data-schemas';
+import type { AppConfig } from '@librechat/data-schemas';
+import {
+ Tools,
+ Constants,
+ isAgentsEndpoint,
+ isEphemeralAgentId,
+ encodeEphemeralAgentId,
+} from 'librechat-data-provider';
+import type {
+ AgentModelParameters,
+ TEphemeralAgent,
+ TModelSpec,
+ Agent,
+} from 'librechat-data-provider';
+import { getCustomEndpointConfig } from '~/app/config';
+
+const { mcp_all, mcp_delimiter } = Constants;
+
+export interface LoadAgentDeps {
+ getAgent: (searchParameter: { id: string }) => Promise<Agent | null>;
+ getMCPServerTools: (
+ userId: string,
+ serverName: string,
+ ) => Promise<Record<string, unknown> | null>;
+}
+
+export interface LoadAgentParams {
+ req: {
+ user?: { id?: string };
+ config?: AppConfig;
+ body?: {
+ promptPrefix?: string;
+ ephemeralAgent?: TEphemeralAgent;
+ };
+ };
+ spec?: string;
+ agent_id: string;
+ endpoint: string;
+ model_parameters?: AgentModelParameters & { model?: string };
+}
+
+/**
+ * Load an ephemeral agent based on the request parameters.
+ */
+export async function loadEphemeralAgent(
+ { req, spec, endpoint, model_parameters: _m }: Omit<LoadAgentParams, 'agent_id'>,
+ deps: LoadAgentDeps,
+): Promise<Agent | null> {
+ const { model, ...model_parameters } = _m ?? ({} as unknown as AgentModelParameters);
+ const modelSpecs = req.config?.modelSpecs as { list?: TModelSpec[] } | undefined;
+ let modelSpec: TModelSpec | null = null;
+ if (spec != null && spec !== '') {
+ modelSpec = modelSpecs?.list?.find((s) => s.name === spec) ?? null;
+ }
+ const ephemeralAgent: TEphemeralAgent | undefined = req.body?.ephemeralAgent;
+ const mcpServers = new Set<string>(ephemeralAgent?.mcp);
+ const userId = req.user?.id ?? '';
+ if (modelSpec?.mcpServers) {
+ for (const mcpServer of modelSpec.mcpServers) {
+ mcpServers.add(mcpServer);
+ }
+ }
+ const tools: string[] = [];
+ if (ephemeralAgent?.execute_code === true || modelSpec?.executeCode === true) {
+ tools.push(Tools.execute_code);
+ }
+ if (ephemeralAgent?.file_search === true || modelSpec?.fileSearch === true) {
+ tools.push(Tools.file_search);
+ }
+ if (ephemeralAgent?.web_search === true || modelSpec?.webSearch === true) {
+ tools.push(Tools.web_search);
+ }
+
+ const addedServers = new Set<string>();
+ if (mcpServers.size > 0) {
+ for (const mcpServer of mcpServers) {
+ if (addedServers.has(mcpServer)) {
+ continue;
+ }
+ const serverTools = await deps.getMCPServerTools(userId, mcpServer);
+ if (!serverTools) {
+ tools.push(`${mcp_all}${mcp_delimiter}${mcpServer}`);
+ addedServers.add(mcpServer);
+ continue;
+ }
+ tools.push(...Object.keys(serverTools));
+ addedServers.add(mcpServer);
+ }
+ }
+
+ const instructions = req.body?.promptPrefix;
+
+ // Get endpoint config for modelDisplayLabel fallback
+ const appConfig = req.config;
+ const endpoints = appConfig?.endpoints;
+ let endpointConfig = endpoints?.[endpoint as keyof typeof endpoints];
+ if (!isAgentsEndpoint(endpoint) && !endpointConfig) {
+ try {
+ endpointConfig = getCustomEndpointConfig({ endpoint, appConfig });
+ } catch (err) {
+ logger.error('[loadEphemeralAgent] Error getting custom endpoint config', err);
+ }
+ }
+
+ // For ephemeral agents, use modelLabel if provided, then model spec's label,
+ // then modelDisplayLabel from endpoint config, otherwise empty string to show model name
+ const sender =
+ (model_parameters as AgentModelParameters & { modelLabel?: string })?.modelLabel ??
+ modelSpec?.label ??
+ (endpointConfig as { modelDisplayLabel?: string } | undefined)?.modelDisplayLabel ??
+ '';
+
+ // Encode ephemeral agent ID with endpoint, model, and computed sender for display
+ const ephemeralId = encodeEphemeralAgentId({
+ endpoint,
+ model: model as string,
+ sender: sender as string,
+ });
+
+ const result: Partial<Agent> = {
+ id: ephemeralId,
+ instructions,
+ provider: endpoint,
+ model_parameters,
+ model,
+ tools,
+ };
+
+ if (ephemeralAgent?.artifacts) {
+ result.artifacts = ephemeralAgent.artifacts;
+ }
+ return result as Agent;
+}
+
+/**
+ * Load an agent based on the provided ID.
+ * For ephemeral agents, builds a synthetic agent from request parameters.
+ * For persistent agents, fetches from the database.
+ */
+export async function loadAgent(
+ params: LoadAgentParams,
+ deps: LoadAgentDeps,
+): Promise<Agent | null> {
+ const { req, spec, agent_id, endpoint, model_parameters } = params;
+ if (!agent_id) {
+ return null;
+ }
+ if (isEphemeralAgentId(agent_id)) {
+ return loadEphemeralAgent({ req, spec, endpoint, model_parameters }, deps);
+ }
+ const agent = await deps.getAgent({ id: agent_id });
+
+ if (!agent) {
+ return null;
+ }
+
+ // Set version count from versions array length
+ const agentWithVersion = agent as Agent & { versions?: unknown[]; version?: number };
+ agentWithVersion.version = agentWithVersion.versions ? agentWithVersion.versions.length : 0;
+ return agent;
+}
diff --git a/packages/api/src/apiKeys/permissions.ts b/packages/api/src/apiKeys/permissions.ts
index 2556f25b57..b617b0a892 100644
--- a/packages/api/src/apiKeys/permissions.ts
+++ b/packages/api/src/apiKeys/permissions.ts
@@ -1,10 +1,11 @@
+import { Types } from 'mongoose';
import {
ResourceType,
PrincipalType,
PermissionBits,
AccessRoleIds,
} from 'librechat-data-provider';
-import type { Types, Model } from 'mongoose';
+import type { PipelineStage, AnyBulkWriteOperation } from 'mongoose';
export interface Principal {
type: string;
@@ -19,20 +20,14 @@ export interface Principal {
}
export interface EnricherDependencies {
- AclEntry: Model<{
- principalType: string;
- principalId: Types.ObjectId;
- resourceType: string;
- resourceId: Types.ObjectId;
- permBits: number;
- roleId: Types.ObjectId;
- grantedBy: Types.ObjectId;
- grantedAt: Date;
- }>;
- AccessRole: Model<{
- accessRoleId: string;
- permBits: number;
- }>;
+ aggregateAclEntries: (pipeline: PipelineStage[]) => Promise<Record<string, unknown>[]>;
+ bulkWriteAclEntries: (
+ ops: AnyBulkWriteOperation<unknown>[],
+ options?: Record<string, unknown>,
+ ) => Promise<unknown>;
+ findRoleByIdentifier: (
+ accessRoleId: string,
+ ) => Promise<{ _id: Types.ObjectId; permBits: number } | null>;
logger: { error: (msg: string, ...args: unknown[]) => void };
}
@@ -47,14 +42,12 @@ export async function enrichRemoteAgentPrincipals(
resourceId: string | Types.ObjectId,
principals: Principal[],
): Promise<EnrichResult> {
- const { AclEntry } = deps;
-
const resourceObjectId =
typeof resourceId === 'string' && /^[a-f\d]{24}$/i.test(resourceId)
- ? deps.AclEntry.base.Types.ObjectId.createFromHexString(resourceId)
+ ? Types.ObjectId.createFromHexString(resourceId)
: resourceId;
- const agentOwnerEntries = await AclEntry.aggregate([
+ const agentOwnerEntries = await deps.aggregateAclEntries([
{
$match: {
resourceType: ResourceType.AGENT,
@@ -87,24 +80,28 @@ export async function enrichRemoteAgentPrincipals(
continue;
}
+ const userInfo = entry.userInfo as Record<string, unknown>;
+ const principalId = entry.principalId as Types.ObjectId;
+
const alreadyIncluded = enrichedPrincipals.some(
- (p) => p.type === PrincipalType.USER && p.id === entry.principalId.toString(),
+ (p) => p.type === PrincipalType.USER && p.id === principalId.toString(),
);
if (!alreadyIncluded) {
enrichedPrincipals.unshift({
type: PrincipalType.USER,
- id: entry.userInfo._id.toString(),
- name: entry.userInfo.name || entry.userInfo.username,
- email: entry.userInfo.email,
- avatar: entry.userInfo.avatar,
+ id: (userInfo._id as Types.ObjectId).toString(),
+ name: (userInfo.name || userInfo.username) as string,
+ email: userInfo.email as string,
+ avatar: userInfo.avatar as string,
source: 'local',
- idOnTheSource: entry.userInfo.idOnTheSource || entry.userInfo._id.toString(),
+ idOnTheSource:
+ (userInfo.idOnTheSource as string) || (userInfo._id as Types.ObjectId).toString(),
accessRoleId: AccessRoleIds.REMOTE_AGENT_OWNER,
isImplicit: true,
});
- entriesToBackfill.push(entry.principalId);
+ entriesToBackfill.push(principalId);
}
}
@@ -121,15 +118,15 @@ export function backfillRemoteAgentPermissions(
return;
}
- const { AclEntry, AccessRole, logger } = deps;
+ const { logger } = deps;
const resourceObjectId =
typeof resourceId === 'string' && /^[a-f\d]{24}$/i.test(resourceId)
- ? AclEntry.base.Types.ObjectId.createFromHexString(resourceId)
+ ? Types.ObjectId.createFromHexString(resourceId)
: resourceId;
- AccessRole.findOne({ accessRoleId: AccessRoleIds.REMOTE_AGENT_OWNER })
- .lean()
+ deps
+ .findRoleByIdentifier(AccessRoleIds.REMOTE_AGENT_OWNER)
.then((role) => {
if (!role) {
logger.error('[backfillRemoteAgentPermissions] REMOTE_AGENT_OWNER role not found');
@@ -161,9 +158,9 @@ export function backfillRemoteAgentPermissions(
},
}));
- return AclEntry.bulkWrite(bulkOps, { ordered: false });
+ return deps.bulkWriteAclEntries(bulkOps, { ordered: false });
})
- .catch((err) => {
+ .catch((err: unknown) => {
logger.error('[backfillRemoteAgentPermissions] Failed to backfill:', err);
});
}
diff --git a/packages/api/src/auth/index.ts b/packages/api/src/auth/index.ts
index 392605ef50..5dd0bb01e0 100644
--- a/packages/api/src/auth/index.ts
+++ b/packages/api/src/auth/index.ts
@@ -2,3 +2,5 @@ export * from './domain';
export * from './openid';
export * from './exchange';
export * from './agent';
+export * from './password';
+export * from './invite';
diff --git a/packages/api/src/auth/invite.ts b/packages/api/src/auth/invite.ts
new file mode 100644
index 0000000000..19e1e54b46
--- /dev/null
+++ b/packages/api/src/auth/invite.ts
@@ -0,0 +1,61 @@
+import { Types } from 'mongoose';
+import { logger, hashToken, getRandomValues } from '@librechat/data-schemas';
+
+export interface InviteDeps {
+ createToken: (data: {
+ userId: Types.ObjectId;
+ email: string;
+ token: string;
+ createdAt: number;
+ expiresIn: number;
+ }) => Promise<unknown>;
+ findToken: (filter: { token: string; email: string }) => Promise<unknown>;
+}
+
+/** Creates a new user invite and returns the encoded token. */
+export async function createInvite(
+ email: string,
+ deps: InviteDeps,
+): Promise<string | { message: string }> {
+ try {
+ const token = await getRandomValues(32);
+ const hash = await hashToken(token);
+ const encodedToken = encodeURIComponent(token);
+ const fakeUserId = new Types.ObjectId();
+
+ await deps.createToken({
+ userId: fakeUserId,
+ email,
+ token: hash,
+ createdAt: Date.now(),
+ expiresIn: 604800,
+ });
+
+ return encodedToken;
+ } catch (error) {
+ logger.error('[createInvite] Error creating invite', error);
+ return { message: 'Error creating invite' };
+ }
+}
+
+/** Retrieves and validates a user invite by encoded token and email. */
+export async function getInvite(
+ encodedToken: string,
+ email: string,
+ deps: InviteDeps,
+): Promise<unknown> {
+ try {
+ const token = decodeURIComponent(encodedToken);
+ const hash = await hashToken(token);
+ const invite = await deps.findToken({ token: hash, email });
+
+ if (!invite) {
+ throw new Error('Invite not found or email does not match');
+ }
+
+ return invite;
+ } catch (error) {
+ logger.error('[getInvite] Error getting invite:', error);
+ return { error: true, message: (error as Error).message };
+ }
+}
diff --git a/packages/api/src/auth/password.ts b/packages/api/src/auth/password.ts
new file mode 100644
index 0000000000..87eea94d7e
--- /dev/null
+++ b/packages/api/src/auth/password.ts
@@ -0,0 +1,25 @@
+interface UserWithPassword {
+ password?: string;
+ [key: string]: unknown;
+}
+
+export interface ComparePasswordDeps {
+ compare: (candidatePassword: string, hash: string) => Promise<boolean>;
+}
+
+/** Compares a candidate password against a user's hashed password. */
+export async function comparePassword(
+ user: UserWithPassword,
+ candidatePassword: string,
+ deps: ComparePasswordDeps,
+): Promise<boolean> {
+ if (!user) {
+ throw new Error('No user provided');
+ }
+
+ if (!user.password) {
+ throw new Error('No password, likely an email first registered via Social/OIDC login');
+ }
+
+ return deps.compare(candidatePassword, user.password);
+}
diff --git a/packages/api/src/mcp/registry/db/ServerConfigsDB.ts b/packages/api/src/mcp/registry/db/ServerConfigsDB.ts
index 50db81b831..9981f6b00b 100644
--- a/packages/api/src/mcp/registry/db/ServerConfigsDB.ts
+++ b/packages/api/src/mcp/registry/db/ServerConfigsDB.ts
@@ -367,12 +367,12 @@ export class ServerConfigsDB implements IServerConfigsRepositoryInterface {
const parsedConfigs: Record<string, ParsedServerConfig> = {};
const directData = directResults.data || [];
- const directServerNames = new Set(directData.map((s) => s.serverName));
+ const directServerNames = new Set(directData.map((s: MCPServerDocument) => s.serverName));
const directParsed = await Promise.all(
- directData.map((s) => this.mapDBServerToParsedConfig(s)),
+ directData.map((s: MCPServerDocument) => this.mapDBServerToParsedConfig(s)),
);
- directData.forEach((s, i) => {
+ directData.forEach((s: MCPServerDocument, i: number) => {
parsedConfigs[s.serverName] = directParsed[i];
});
@@ -385,9 +385,9 @@ export class ServerConfigsDB implements IServerConfigsRepositoryInterface {
const agentData = agentServers.data || [];
const agentParsed = await Promise.all(
- agentData.map((s) => this.mapDBServerToParsedConfig(s)),
+ agentData.map((s: MCPServerDocument) => this.mapDBServerToParsedConfig(s)),
);
- agentData.forEach((s, i) => {
+ agentData.forEach((s: MCPServerDocument, i: number) => {
parsedConfigs[s.serverName] = { ...agentParsed[i], consumeOnly: true };
});
}
diff --git a/packages/api/src/middleware/access.spec.ts b/packages/api/src/middleware/access.spec.ts
index c0efa9fcc1..99257adf6d 100644
--- a/packages/api/src/middleware/access.spec.ts
+++ b/packages/api/src/middleware/access.spec.ts
@@ -216,12 +216,12 @@ describe('access middleware', () => {
defaultParams.getRoleByName.mockResolvedValue(mockRole);
- const checkObject = {};
+ const checkObject = { id: 'agent123' };
const result = await checkAccess({
...defaultParams,
permissions: [Permissions.USE, Permissions.SHARE],
- bodyProps: {} as Record<Permissions, string[]>,
+ bodyProps: { [Permissions.SHARE]: ['id'] } as Record<Permissions, string[]>,
checkObject,
});
expect(result).toBe(true);
@@ -333,12 +333,12 @@ describe('access middleware', () => {
} as unknown as IRole;
mockGetRoleByName.mockResolvedValue(mockRole);
- mockReq.body = {};
+ mockReq.body = { id: 'agent123' };
const middleware = generateCheckAccess({
permissionType: PermissionTypes.AGENTS,
permissions: [Permissions.USE, Permissions.CREATE, Permissions.SHARE],
- bodyProps: {} as Record<Permissions, string[]>,
+ bodyProps: { [Permissions.SHARE]: ['id'] } as Record<Permissions, string[]>,
getRoleByName: mockGetRoleByName,
});
diff --git a/packages/api/src/middleware/balance.spec.ts b/packages/api/src/middleware/balance.spec.ts
index 076ec6d519..fe995d9f6b 100644
--- a/packages/api/src/middleware/balance.spec.ts
+++ b/packages/api/src/middleware/balance.spec.ts
@@ -2,7 +2,7 @@ import mongoose from 'mongoose';
import { MongoMemoryServer } from 'mongodb-memory-server';
import { logger, balanceSchema } from '@librechat/data-schemas';
import type { NextFunction, Request as ServerRequest, Response as ServerResponse } from 'express';
-import type { IBalance } from '@librechat/data-schemas';
+import type { IBalance, IBalanceUpdate } from '@librechat/data-schemas';
import { createSetBalanceConfig } from './balance';
jest.mock('@librechat/data-schemas', () => ({
@@ -15,6 +15,16 @@ jest.mock('@librechat/data-schemas', () => ({
let mongoServer: MongoMemoryServer;
let Balance: mongoose.Model<IBalance>;
+const findBalanceByUser = (userId: string) =>
+ Balance.findOne({ user: userId }).lean() as Promise<IBalance | null>;
+
+const upsertBalanceFields = (userId: string, fields: IBalanceUpdate) =>
+ Balance.findOneAndUpdate(
+ { user: userId },
+ { $set: fields },
+ { upsert: true, new: true },
+ ).lean() as Promise<IBalance | null>;
+
beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
const mongoUri = mongoServer.getUri();
@@ -64,7 +74,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -95,7 +106,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -120,7 +132,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -149,7 +162,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -178,7 +192,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = {} as ServerRequest;
@@ -219,7 +234,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -271,7 +287,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -315,7 +332,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -346,7 +364,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -392,7 +411,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -434,21 +454,20 @@ describe('createSetBalanceConfig', () => {
},
});
- const middleware = createSetBalanceConfig({
- getAppConfig,
- Balance,
- });
-
const req = createMockRequest(userId);
const res = createMockResponse();
- // Spy on Balance.findOneAndUpdate to verify it's not called
- const updateSpy = jest.spyOn(Balance, 'findOneAndUpdate');
+ const upsertSpy = jest.fn();
+ const spiedMiddleware = createSetBalanceConfig({
+ getAppConfig,
+ findBalanceByUser,
+ upsertBalanceFields: upsertSpy,
+ });
- await middleware(req as ServerRequest, res as ServerResponse, mockNext);
+ await spiedMiddleware(req as ServerRequest, res as ServerResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
- expect(updateSpy).not.toHaveBeenCalled();
+ expect(upsertSpy).not.toHaveBeenCalled();
});
test('should set tokenCredits for user with null tokenCredits', async () => {
@@ -470,7 +489,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -498,16 +518,12 @@ describe('createSetBalanceConfig', () => {
});
const dbError = new Error('Database error');
- // Mock Balance.findOne to throw an error
- jest.spyOn(Balance, 'findOne').mockImplementationOnce((() => {
- return {
- lean: jest.fn().mockRejectedValue(dbError),
- };
- }) as unknown as mongoose.Model<IBalance>['findOne']);
+ const failingFindBalance = () => Promise.reject(dbError);
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser: failingFindBalance,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -526,7 +542,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -556,7 +573,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -590,7 +608,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
@@ -635,7 +654,8 @@ describe('createSetBalanceConfig', () => {
const middleware = createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
});
const req = createMockRequest(userId);
diff --git a/packages/api/src/middleware/balance.ts b/packages/api/src/middleware/balance.ts
index e3eb1e7ae1..8c6b149cdd 100644
--- a/packages/api/src/middleware/balance.ts
+++ b/packages/api/src/middleware/balance.ts
@@ -1,13 +1,20 @@
import { logger } from '@librechat/data-schemas';
+import type {
+ IBalanceUpdate,
+ BalanceConfig,
+ AppConfig,
+ ObjectId,
+ IBalance,
+ IUser,
+} from '@librechat/data-schemas';
import type { NextFunction, Request as ServerRequest, Response as ServerResponse } from 'express';
-import type { IBalance, IUser, BalanceConfig, ObjectId, AppConfig } from '@librechat/data-schemas';
-import type { Model } from 'mongoose';
import type { BalanceUpdateFields } from '~/types';
import { getBalanceConfig } from '~/app/config';
export interface BalanceMiddlewareOptions {
getAppConfig: (options?: { role?: string; refresh?: boolean }) => Promise<AppConfig>;
- Balance: Model<IBalance>;
+ findBalanceByUser: (userId: string) => Promise<IBalance | null>;
+ upsertBalanceFields: (userId: string, fields: IBalanceUpdate) => Promise<IBalance | null>;
}
/**
@@ -75,7 +82,8 @@ function buildUpdateFields(
*/
export function createSetBalanceConfig({
getAppConfig,
- Balance,
+ findBalanceByUser,
+ upsertBalanceFields,
}: BalanceMiddlewareOptions): (
req: ServerRequest,
res: ServerResponse,
@@ -97,18 +105,14 @@ export function createSetBalanceConfig({
return next();
}
const userId = typeof user._id === 'string' ? user._id : user._id.toString();
- const userBalanceRecord = await Balance.findOne({ user: userId }).lean();
+ const userBalanceRecord = await findBalanceByUser(userId);
const updateFields = buildUpdateFields(balanceConfig, userBalanceRecord, userId);
if (Object.keys(updateFields).length === 0) {
return next();
}
- await Balance.findOneAndUpdate(
- { user: userId },
- { $set: updateFields },
- { upsert: true, new: true },
- );
+ await upsertBalanceFields(userId, updateFields);
next();
} catch (error) {
diff --git a/packages/api/src/middleware/checkBalance.ts b/packages/api/src/middleware/checkBalance.ts
new file mode 100644
index 0000000000..d99874dc07
--- /dev/null
+++ b/packages/api/src/middleware/checkBalance.ts
@@ -0,0 +1,168 @@
+import { logger } from '@librechat/data-schemas';
+import { ViolationTypes } from 'librechat-data-provider';
+import type { ServerRequest } from '~/types/http';
+import type { Response } from 'express';
+
+type TimeUnit = 'seconds' | 'minutes' | 'hours' | 'days' | 'weeks' | 'months';
+
+interface BalanceRecord {
+ tokenCredits: number;
+ autoRefillEnabled?: boolean;
+ refillAmount?: number;
+ lastRefill?: Date;
+ refillIntervalValue?: number;
+ refillIntervalUnit?: TimeUnit;
+}
+
+interface TxData {
+ user: string;
+ model?: string;
+ endpoint?: string;
+ valueKey?: string;
+ tokenType?: string;
+ amount: number;
+ endpointTokenConfig?: unknown;
+ generations?: unknown[];
+}
+
+export interface CheckBalanceDeps {
+ findBalanceByUser: (user: string) => Promise<BalanceRecord | null>;
+ getMultiplier: (params: Record<string, unknown>) => number;
+ createAutoRefillTransaction: (
+ data: Record<string, unknown>,
+ ) => Promise<{ balance: number } | undefined>;
+ logViolation: (
+ req: unknown,
+ res: unknown,
+ type: string,
+ errorMessage: Record<string, unknown>,
+ score: number,
+ ) => Promise<void>;
+}
+
+function addIntervalToDate(date: Date, value: number, unit: TimeUnit): Date {
+ const result = new Date(date);
+ switch (unit) {
+ case 'seconds':
+ result.setSeconds(result.getSeconds() + value);
+ break;
+ case 'minutes':
+ result.setMinutes(result.getMinutes() + value);
+ break;
+ case 'hours':
+ result.setHours(result.getHours() + value);
+ break;
+ case 'days':
+ result.setDate(result.getDate() + value);
+ break;
+ case 'weeks':
+ result.setDate(result.getDate() + value * 7);
+ break;
+ case 'months':
+ result.setMonth(result.getMonth() + value);
+ break;
+ default:
+ break;
+ }
+ return result;
+}
+
+/** Checks a user's balance record and handles auto-refill if needed. */
+async function checkBalanceRecord(
+ txData: TxData,
+ deps: CheckBalanceDeps,
+): Promise<{ canSpend: boolean; balance: number; tokenCost: number }> {
+ const { user, model, endpoint, valueKey, tokenType, amount, endpointTokenConfig } = txData;
+ const multiplier = deps.getMultiplier({
+ valueKey,
+ tokenType,
+ model,
+ endpoint,
+ endpointTokenConfig,
+ });
+ const tokenCost = amount * multiplier;
+
+ const record = await deps.findBalanceByUser(user);
+ if (!record) {
+ logger.debug('[Balance.check] No balance record found for user', { user });
+ return { canSpend: false, balance: 0, tokenCost };
+ }
+ let balance = record.tokenCredits;
+
+ logger.debug('[Balance.check] Initial state', {
+ user,
+ model,
+ endpoint,
+ valueKey,
+ tokenType,
+ amount,
+ balance,
+ multiplier,
+ endpointTokenConfig: !!endpointTokenConfig,
+ });
+
+ if (
+ balance - tokenCost <= 0 &&
+ record.autoRefillEnabled &&
+ record.refillAmount &&
+ record.refillAmount > 0
+ ) {
+ const lastRefillDate = new Date(record.lastRefill ?? 0);
+ const now = new Date();
+ if (
+ isNaN(lastRefillDate.getTime()) ||
+ now >=
+ addIntervalToDate(
+ lastRefillDate,
+ record.refillIntervalValue ?? 0,
+ record.refillIntervalUnit ?? 'days',
+ )
+ ) {
+ try {
+ const result = await deps.createAutoRefillTransaction({
+ user,
+ tokenType: 'credits',
+ context: 'autoRefill',
+ rawAmount: record.refillAmount,
+ });
+ if (result) {
+ balance = result.balance;
+ }
+ } catch (error) {
+ logger.error('[Balance.check] Failed to record transaction for auto-refill', error);
+ }
+ }
+ }
+
+ logger.debug('[Balance.check] Token cost', { tokenCost });
+ return { canSpend: balance >= tokenCost, balance, tokenCost };
+}
+
+/**
+ * Checks balance for a user and logs a violation if they cannot spend.
+ * Throws an error with the balance info if insufficient funds.
+ */
+export async function checkBalance(
+ { req, res, txData }: { req: ServerRequest; res: Response; txData: TxData },
+ deps: CheckBalanceDeps,
+): Promise<boolean> {
+ const { canSpend, balance, tokenCost } = await checkBalanceRecord(txData, deps);
+ if (canSpend) {
+ return true;
+ }
+
+ const type = ViolationTypes.TOKEN_BALANCE;
+ const errorMessage: Record<string, unknown> = {
+ type,
+ balance,
+ tokenCost,
+ promptTokens: txData.amount,
+ };
+
+ if (txData.generations && txData.generations.length > 0) {
+ errorMessage.generations = txData.generations;
+ }
+
+ await deps.logViolation(req, res, type, errorMessage, 0);
+ throw new Error(JSON.stringify(errorMessage));
+}
diff --git a/packages/api/src/middleware/index.ts b/packages/api/src/middleware/index.ts
index 1f0cbc16fb..7787d89dfe 100644
--- a/packages/api/src/middleware/index.ts
+++ b/packages/api/src/middleware/index.ts
@@ -5,3 +5,4 @@ export * from './notFound';
export * from './balance';
export * from './json';
export * from './concurrency';
+export * from './checkBalance';
diff --git a/packages/api/src/prompts/format.ts b/packages/api/src/prompts/format.ts
index df2b11b59a..de3d4e8a74 100644
--- a/packages/api/src/prompts/format.ts
+++ b/packages/api/src/prompts/format.ts
@@ -1,8 +1,8 @@
+import { escapeRegExp } from '@librechat/data-schemas';
import { SystemCategories } from 'librechat-data-provider';
import type { IPromptGroupDocument as IPromptGroup } from '@librechat/data-schemas';
import type { Types } from 'mongoose';
import type { PromptGroupsListResponse } from '~/types';
-import { escapeRegExp } from '~/utils/common';
/**
* Formats prompt groups for the paginated /groups endpoint response
diff --git a/packages/api/src/utils/common.ts b/packages/api/src/utils/common.ts
index 6f4871b741..a5860b0a69 100644
--- a/packages/api/src/utils/common.ts
+++ b/packages/api/src/utils/common.ts
@@ -48,12 +48,3 @@ export function optionalChainWithEmptyCheck(
}
return values[values.length - 1];
}
-
-/**
- * Escapes special characters in a string for use in a regular expression.
- * @param str - The string to escape.
- * @returns The escaped string safe for use in RegExp.
- */
-export function escapeRegExp(str: string): string {
- return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-}
diff --git a/packages/api/src/utils/index.ts b/packages/api/src/utils/index.ts
index 3320fef949..50582832c0 100644
--- a/packages/api/src/utils/index.ts
+++ b/packages/api/src/utils/index.ts
@@ -20,7 +20,6 @@ export * from './openid';
export * from './promise';
export * from './ports';
export * from './sanitizeTitle';
-export * from './tempChatRetention';
export * from './text';
export * from './yaml';
export * from './http';
diff --git a/packages/data-schemas/rollup.config.js b/packages/data-schemas/rollup.config.js
index c9f8838e77..d58331feee 100644
--- a/packages/data-schemas/rollup.config.js
+++ b/packages/data-schemas/rollup.config.js
@@ -29,7 +29,7 @@ export default {
commonjs(),
// Compile TypeScript files and generate type declarations
typescript({
- tsconfig: './tsconfig.json',
+ tsconfig: './tsconfig.build.json',
declaration: true,
declarationDir: 'dist/types',
rootDir: 'src',
diff --git a/packages/data-schemas/src/index.ts b/packages/data-schemas/src/index.ts
index a9c9a56078..ae69fc58bb 100644
--- a/packages/data-schemas/src/index.ts
+++ b/packages/data-schemas/src/index.ts
@@ -4,7 +4,15 @@ export * from './crypto';
export * from './schema';
export * from './utils';
export { createModels } from './models';
-export { createMethods, DEFAULT_REFRESH_TOKEN_EXPIRY, DEFAULT_SESSION_EXPIRY } from './methods';
+export {
+ createMethods,
+ DEFAULT_REFRESH_TOKEN_EXPIRY,
+ DEFAULT_SESSION_EXPIRY,
+ tokenValues,
+ cacheTokenValues,
+ premiumTokenValues,
+ defaultRate,
+} from './methods';
export type * from './types';
export type * from './methods';
export { default as logger } from './config/winston';
diff --git a/packages/data-schemas/src/methods/aclEntry.ts b/packages/data-schemas/src/methods/aclEntry.ts
index ff27a7046f..82e277254a 100644
--- a/packages/data-schemas/src/methods/aclEntry.ts
+++ b/packages/data-schemas/src/methods/aclEntry.ts
@@ -1,6 +1,12 @@
import { Types } from 'mongoose';
-import { PrincipalType, PrincipalModel } from 'librechat-data-provider';
-import type { Model, DeleteResult, ClientSession } from 'mongoose';
+import { PrincipalType, PrincipalModel, PermissionBits } from 'librechat-data-provider';
+import type {
+ AnyBulkWriteOperation,
+ ClientSession,
+ PipelineStage,
+ DeleteResult,
+ Model,
+} from 'mongoose';
import type { IAclEntry } from '~/types';
export function createAclEntryMethods(mongoose: typeof import('mongoose')) {
@@ -349,6 +355,103 @@ export function createAclEntryMethods(mongoose: typeof import('mongoose')) {
return entries;
}
+ /**
+ * Deletes ACL entries matching the given filter.
+ * @param filter - MongoDB filter query
+ * @param options - Optional query options (e.g., { session })
+ */
+ async function deleteAclEntries(
+ filter: Record<string, unknown>,
+ options?: { session?: ClientSession },
+ ): Promise<DeleteResult> {
+ const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
+ return AclEntry.deleteMany(filter, options || {});
+ }
+
+ /**
+ * Performs a bulk write operation on ACL entries.
+ * @param ops - Array of bulk write operations
+ * @param options - Optional query options (e.g., { session })
+ */
+ async function bulkWriteAclEntries(
+ ops: AnyBulkWriteOperation<IAclEntry>[],
+ options?: { session?: ClientSession },
+ ) {
+ const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
+ return AclEntry.bulkWrite(ops, options || {});
+ }
+
+ /**
+ * Finds all publicly accessible resource IDs for a given resource type.
+ * @param resourceType - The type of resource
+ * @param requiredPermissions - Required permission bits
+ */
+ async function findPublicResourceIds(
+ resourceType: string,
+ requiredPermissions: number,
+ ): Promise<Types.ObjectId[]> {
+ const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
+ return AclEntry.find({
+ principalType: PrincipalType.PUBLIC,
+ resourceType,
+ permBits: { $bitsAllSet: requiredPermissions },
+ }).distinct('resourceId');
+ }
+
+ /**
+ * Runs an aggregation pipeline on the AclEntry collection.
+ * @param pipeline - MongoDB aggregation pipeline stages
+ */
+ async function aggregateAclEntries(pipeline: PipelineStage[]) {
+ const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
+ return AclEntry.aggregate(pipeline);
+ }
+
+ /**
+ * Returns resource IDs solely owned by the given user (no other principals
+ * hold DELETE on the same resource). Handles both single and array resource types.
+ */
+ async function getSoleOwnedResourceIds(
+ userObjectId: Types.ObjectId,
+ resourceTypes: string | string[],
+ ): Promise<Types.ObjectId[]> {
+ const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
+ const types = Array.isArray(resourceTypes) ? resourceTypes : [resourceTypes];
+
+ const ownedEntries = await AclEntry.find({
+ principalType: PrincipalType.USER,
+ principalId: userObjectId,
+ resourceType: { $in: types },
+ permBits: { $bitsAllSet: PermissionBits.DELETE },
+ })
+ .select('resourceId')
+ .lean();
+
+ if (ownedEntries.length === 0) {
+ return [];
+ }
+
+ const ownedIds = ownedEntries.map((e) => e.resourceId);
+
+ const otherOwners = await AclEntry.aggregate([
+ {
+ $match: {
+ resourceType: { $in: types },
+ resourceId: { $in: ownedIds },
+ permBits: { $bitsAllSet: PermissionBits.DELETE },
+ $or: [
+ { principalId: { $ne: userObjectId } },
+ { principalType: { $ne: PrincipalType.USER } },
+ ],
+ },
+ },
+ { $group: { _id: '$resourceId' } },
+ ]);
+
+ const multiOwnerIds = new Set(otherOwners.map((doc: { _id: Types.ObjectId }) => doc._id.toString()));
+ return ownedIds.filter((id) => !multiOwnerIds.has(id.toString()));
+ }
+
return {
findEntriesByPrincipal,
findEntriesByResource,
@@ -360,6 +463,11 @@ export function createAclEntryMethods(mongoose: typeof import('mongoose')) {
revokePermission,
modifyPermissionBits,
findAccessibleResources,
+ deleteAclEntries,
+ bulkWriteAclEntries,
+ findPublicResourceIds,
+ aggregateAclEntries,
+ getSoleOwnedResourceIds,
};
}
diff --git a/packages/data-schemas/src/methods/action.ts b/packages/data-schemas/src/methods/action.ts
new file mode 100644
index 0000000000..9467ad6a76
--- /dev/null
+++ b/packages/data-schemas/src/methods/action.ts
@@ -0,0 +1,77 @@
+import type { FilterQuery, Model } from 'mongoose';
+import type { IAction } from '~/types';
+
+const sensitiveFields = ['api_key', 'oauth_client_id', 'oauth_client_secret'] as const;
+
+export function createActionMethods(mongoose: typeof import('mongoose')) {
+ /**
+ * Update an action with new data without overwriting existing properties,
+ * or create a new action if it doesn't exist.
+ */
+ async function updateAction(
+ searchParams: FilterQuery<IAction>,
+ updateData: Partial<IAction>,
+ ): Promise<IAction | null> {
+ const Action = mongoose.models.Action as Model<IAction>;
+ const options = { new: true, upsert: true };
+ return (await Action.findOneAndUpdate(
+ searchParams,
+ updateData,
+ options,
+ ).lean()) as IAction | null;
+ }
+
+ /**
+ * Retrieves all actions that match the given search parameters.
+ */
+ async function getActions(
+ searchParams: FilterQuery<IAction>,
+ includeSensitive = false,
+ ): Promise<IAction[]> {
+ const Action = mongoose.models.Action as Model<IAction>;
+ const actions = (await Action.find(searchParams).lean()) as IAction[];
+
+ if (!includeSensitive) {
+ for (let i = 0; i < actions.length; i++) {
+ const metadata = actions[i].metadata;
+ if (!metadata) {
+ continue;
+ }
+
+ for (const field of sensitiveFields) {
+ if (metadata[field]) {
+ delete metadata[field];
+ }
+ }
+ }
+ }
+
+ return actions;
+ }
+
+ /**
+ * Deletes an action by params.
+ */
+ async function deleteAction(searchParams: FilterQuery<IAction>): Promise<IAction | null> {
+ const Action = mongoose.models.Action as Model<IAction>;
+ return (await Action.findOneAndDelete(searchParams).lean()) as IAction | null;
+ }
+
+ /**
+ * Deletes actions by params.
+ */
+ async function deleteActions(searchParams: FilterQuery<IAction>): Promise<number> {
+ const Action = mongoose.models.Action as Model<IAction>;
+ const result = await Action.deleteMany(searchParams);
+ return result.deletedCount;
+ }
+
+ return {
+ getActions,
+ updateAction,
+ deleteAction,
+ deleteActions,
+ };
+}
+
+export type ActionMethods = ReturnType<typeof createActionMethods>;
diff --git a/api/models/Agent.spec.js b/packages/data-schemas/src/methods/agent.spec.ts
similarity index 71%
rename from api/models/Agent.spec.js
rename to packages/data-schemas/src/methods/agent.spec.ts
index ba2991cff7..f828c8c325 100644
--- a/api/models/Agent.spec.js
+++ b/packages/data-schemas/src/methods/agent.spec.ts
@@ -1,66 +1,120 @@
-const originalEnv = {
- CREDS_KEY: process.env.CREDS_KEY,
- CREDS_IV: process.env.CREDS_IV,
-};
-
-process.env.CREDS_KEY = '0123456789abcdef0123456789abcdef';
-process.env.CREDS_IV = '0123456789abcdef';
-
-jest.mock('~/server/services/Config', () => ({
- getCachedTools: jest.fn(),
- getMCPServerTools: jest.fn(),
-}));
-
-const mongoose = require('mongoose');
-const { v4: uuidv4 } = require('uuid');
-const { agentSchema } = require('@librechat/data-schemas');
-const { MongoMemoryServer } = require('mongodb-memory-server');
-const {
- ResourceType,
+import mongoose from 'mongoose';
+import { v4 as uuidv4 } from 'uuid';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import {
AccessRoleIds,
+ ResourceType,
PrincipalType,
+ PrincipalModel,
PermissionBits,
-} = require('librechat-data-provider');
-const {
- getAgent,
- loadAgent,
- createAgent,
- updateAgent,
- deleteAgent,
- deleteUserAgents,
- revertAgentVersion,
- addAgentResourceFile,
- getListAgentsByAccess,
- removeAgentResourceFiles,
- generateActionMetadataHash,
-} = require('./Agent');
-const permissionService = require('~/server/services/PermissionService');
-const { getCachedTools, getMCPServerTools } = require('~/server/services/Config');
-const { AclEntry, User } = require('~/db/models');
-
-/**
- * @type {import('mongoose').Model<import('@librechat/data-schemas').IAgent>}
- */
-let Agent;
-
-describe('models/Agent', () => {
- describe('Agent Resource File Operations', () => {
- let mongoServer;
+ EToolResources,
+} from 'librechat-data-provider';
+import type {
+ UpdateWithAggregationPipeline,
+ RootFilterQuery,
+ QueryOptions,
+ UpdateQuery,
+} from 'mongoose';
+import type { IAgent, IAclEntry, IUser, IAccessRole } from '..';
+import { createAgentMethods, type AgentMethods } from './agent';
+import { createModels } from '~/models';
+
+/** Version snapshot stored in `IAgent.versions[]`. Extends the base omit with runtime-only fields. */
+type VersionEntry = Omit<IAgent, 'versions'> & {
+ __v?: number;
+ versions?: unknown;
+ version?: number;
+ updatedBy?: mongoose.Types.ObjectId;
+};
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- Agent = mongoose.models.Agent || mongoose.model('Agent', agentSchema);
- await mongoose.connect(mongoUri);
- }, 20000);
+jest.mock('~/config/winston', () => ({
+ error: jest.fn(),
+ warn: jest.fn(),
+ info: jest.fn(),
+ debug: jest.fn(),
+}));
- afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- process.env.CREDS_KEY = originalEnv.CREDS_KEY;
- process.env.CREDS_IV = originalEnv.CREDS_IV;
- });
+let mongoServer: InstanceType<typeof MongoMemoryServer>;
+let Agent: mongoose.Model<IAgent>;
+let AclEntry: mongoose.Model<IAclEntry>;
+let User: mongoose.Model<IUser>;
+let AccessRole: mongoose.Model<IAccessRole>;
+let modelsToCleanup: string[] = [];
+let methods: ReturnType<typeof createAgentMethods>;
+
+let createAgent: AgentMethods['createAgent'];
+let getAgent: AgentMethods['getAgent'];
+let updateAgent: AgentMethods['updateAgent'];
+let deleteAgent: AgentMethods['deleteAgent'];
+let deleteUserAgents: AgentMethods['deleteUserAgents'];
+let revertAgentVersion: AgentMethods['revertAgentVersion'];
+let addAgentResourceFile: AgentMethods['addAgentResourceFile'];
+let removeAgentResourceFiles: AgentMethods['removeAgentResourceFiles'];
+let getListAgentsByAccess: AgentMethods['getListAgentsByAccess'];
+let generateActionMetadataHash: AgentMethods['generateActionMetadataHash'];
+
+const getActions = jest.fn().mockResolvedValue([]);
+
+beforeAll(async () => {
+ mongoServer = await MongoMemoryServer.create();
+ const mongoUri = mongoServer.getUri();
+
+ const models = createModels(mongoose);
+ modelsToCleanup = Object.keys(models);
+ Agent = mongoose.models.Agent as mongoose.Model<IAgent>;
+ AclEntry = mongoose.models.AclEntry as mongoose.Model<IAclEntry>;
+ User = mongoose.models.User as mongoose.Model<IUser>;
+ AccessRole = mongoose.models.AccessRole as mongoose.Model<IAccessRole>;
+
+ const removeAllPermissions = async ({
+ resourceType,
+ resourceId,
+ }: {
+ resourceType: string;
+ resourceId: unknown;
+ }) => {
+ await AclEntry.deleteMany({ resourceType, resourceId });
+ };
+
+ methods = createAgentMethods(mongoose, { removeAllPermissions, getActions });
+ createAgent = methods.createAgent;
+ getAgent = methods.getAgent;
+ updateAgent = methods.updateAgent;
+ deleteAgent = methods.deleteAgent;
+ deleteUserAgents = methods.deleteUserAgents;
+ revertAgentVersion = methods.revertAgentVersion;
+ addAgentResourceFile = methods.addAgentResourceFile;
+ removeAgentResourceFiles = methods.removeAgentResourceFiles;
+ getListAgentsByAccess = methods.getListAgentsByAccess;
+ generateActionMetadataHash = methods.generateActionMetadataHash;
+
+ await mongoose.connect(mongoUri);
+
+ await AccessRole.create({
+ accessRoleId: AccessRoleIds.AGENT_OWNER,
+ name: 'Owner',
+ description: 'Full control over agents',
+ resourceType: ResourceType.AGENT,
+ permBits: 15,
+ });
+}, 30000);
+
+afterAll(async () => {
+ const collections = mongoose.connection.collections;
+ for (const key in collections) {
+ await collections[key].deleteMany({});
+ }
+ for (const modelName of modelsToCleanup) {
+ if (mongoose.models[modelName]) {
+ delete (mongoose.models as Record<string, unknown>)[modelName];
+ }
+ }
+ await mongoose.disconnect();
+ await mongoServer.stop();
+});
+describe('Agent Methods', () => {
+ describe('Agent Resource File Operations', () => {
beforeEach(async () => {
await Agent.deleteMany({});
await User.deleteMany({});
@@ -77,10 +131,10 @@ describe('models/Agent', () => {
file_id: fileId,
});
- expect(updatedAgent.tools).toContain(toolResource);
- expect(Array.isArray(updatedAgent.tools)).toBe(true);
+ expect(updatedAgent!.tools).toContain(toolResource);
+ expect(Array.isArray(updatedAgent!.tools)).toBe(true);
// Should not duplicate
- const count = updatedAgent.tools.filter((t) => t === toolResource).length;
+ const count = updatedAgent!.tools?.filter((t) => t === toolResource).length ?? 0;
expect(count).toBe(1);
});
@@ -104,9 +158,9 @@ describe('models/Agent', () => {
file_id: fileId2,
});
- expect(updatedAgent.tools).toContain(toolResource);
- expect(Array.isArray(updatedAgent.tools)).toBe(true);
- const count = updatedAgent.tools.filter((t) => t === toolResource).length;
+ expect(updatedAgent!.tools).toContain(toolResource);
+ expect(Array.isArray(updatedAgent!.tools)).toBe(true);
+ const count = updatedAgent!.tools?.filter((t) => t === toolResource).length ?? 0;
expect(count).toBe(1);
});
@@ -120,9 +174,13 @@ describe('models/Agent', () => {
await Promise.all(additionPromises);
const updatedAgent = await Agent.findOne({ id: agent.id });
- expect(updatedAgent.tool_resources.test_tool.file_ids).toBeDefined();
- expect(updatedAgent.tool_resources.test_tool.file_ids).toHaveLength(10);
- expect(new Set(updatedAgent.tool_resources.test_tool.file_ids).size).toBe(10);
+ expect(updatedAgent?.tool_resources?.[EToolResources.execute_code]?.file_ids).toBeDefined();
+ expect(updatedAgent?.tool_resources?.[EToolResources.execute_code]?.file_ids).toHaveLength(
+ 10,
+ );
+ expect(
+ new Set(updatedAgent?.tool_resources?.[EToolResources.execute_code]?.file_ids).size,
+ ).toBe(10);
});
test('should handle concurrent additions and removals', async () => {
@@ -132,18 +190,18 @@ describe('models/Agent', () => {
await Promise.all(createFileOperations(agent.id, initialFileIds, 'add'));
const newFileIds = Array.from({ length: 5 }, () => uuidv4());
- const operations = [
+ const operations: Promise<IAgent>[] = [
...newFileIds.map((fileId) =>
addAgentResourceFile({
agent_id: agent.id,
- tool_resource: 'test_tool',
+ tool_resource: EToolResources.execute_code,
file_id: fileId,
}),
),
...initialFileIds.map((fileId) =>
removeAgentResourceFiles({
agent_id: agent.id,
- files: [{ tool_resource: 'test_tool', file_id: fileId }],
+ files: [{ tool_resource: EToolResources.execute_code, file_id: fileId }],
}),
),
];
@@ -151,8 +209,8 @@ describe('models/Agent', () => {
await Promise.all(operations);
const updatedAgent = await Agent.findOne({ id: agent.id });
- expect(updatedAgent.tool_resources.test_tool.file_ids).toBeDefined();
- expect(updatedAgent.tool_resources.test_tool.file_ids).toHaveLength(5);
+ expect(updatedAgent?.tool_resources?.[EToolResources.execute_code]?.file_ids).toBeDefined();
+ expect(updatedAgent?.tool_resources?.[EToolResources.execute_code]?.file_ids).toHaveLength(5);
});
test('should initialize array when adding to non-existent tool resource', async () => {
@@ -161,13 +219,13 @@ describe('models/Agent', () => {
const updatedAgent = await addAgentResourceFile({
agent_id: agent.id,
- tool_resource: 'new_tool',
+ tool_resource: EToolResources.context,
file_id: fileId,
});
- expect(updatedAgent.tool_resources.new_tool.file_ids).toBeDefined();
- expect(updatedAgent.tool_resources.new_tool.file_ids).toHaveLength(1);
- expect(updatedAgent.tool_resources.new_tool.file_ids[0]).toBe(fileId);
+ expect(updatedAgent?.tool_resources?.[EToolResources.context]?.file_ids).toBeDefined();
+ expect(updatedAgent?.tool_resources?.[EToolResources.context]?.file_ids).toHaveLength(1);
+ expect(updatedAgent?.tool_resources?.[EToolResources.context]?.file_ids?.[0]).toBe(fileId);
});
test('should handle rapid sequential modifications to same tool resource', async () => {
@@ -177,27 +235,33 @@ describe('models/Agent', () => {
for (let i = 0; i < 10; i++) {
await addAgentResourceFile({
agent_id: agent.id,
- tool_resource: 'test_tool',
+ tool_resource: EToolResources.execute_code,
file_id: `${fileId}_${i}`,
});
if (i % 2 === 0) {
await removeAgentResourceFiles({
agent_id: agent.id,
- files: [{ tool_resource: 'test_tool', file_id: `${fileId}_${i}` }],
+ files: [{ tool_resource: EToolResources.execute_code, file_id: `${fileId}_${i}` }],
});
}
}
const updatedAgent = await Agent.findOne({ id: agent.id });
- expect(updatedAgent.tool_resources.test_tool.file_ids).toBeDefined();
- expect(Array.isArray(updatedAgent.tool_resources.test_tool.file_ids)).toBe(true);
+ expect(updatedAgent?.tool_resources?.[EToolResources.execute_code]?.file_ids).toBeDefined();
+ expect(
+ Array.isArray(updatedAgent!.tool_resources![EToolResources.execute_code]!.file_ids),
+ ).toBe(true);
});
test('should handle multiple tool resources concurrently', async () => {
const agent = await createBasicAgent();
- const toolResources = ['tool1', 'tool2', 'tool3'];
- const operations = [];
+ const toolResources = [
+ EToolResources.file_search,
+ EToolResources.execute_code,
+ EToolResources.image_edit,
+ ] as const;
+ const operations: Promise<IAgent>[] = [];
toolResources.forEach((tool) => {
const fileIds = Array.from({ length: 5 }, () => uuidv4());
@@ -216,8 +280,8 @@ describe('models/Agent', () => {
const updatedAgent = await Agent.findOne({ id: agent.id });
toolResources.forEach((tool) => {
- expect(updatedAgent.tool_resources[tool].file_ids).toBeDefined();
- expect(updatedAgent.tool_resources[tool].file_ids).toHaveLength(5);
+ expect(updatedAgent!.tool_resources![tool]!.file_ids).toBeDefined();
+ expect(updatedAgent!.tool_resources![tool]!.file_ids).toHaveLength(5);
});
});
@@ -246,7 +310,7 @@ describe('models/Agent', () => {
if (setupFile) {
await addAgentResourceFile({
agent_id: agent.id,
- tool_resource: 'test_tool',
+ tool_resource: EToolResources.execute_code,
file_id: fileId,
});
}
@@ -255,19 +319,19 @@ describe('models/Agent', () => {
operation === 'add'
? addAgentResourceFile({
agent_id: agent.id,
- tool_resource: 'test_tool',
+ tool_resource: EToolResources.execute_code,
file_id: fileId,
})
: removeAgentResourceFiles({
agent_id: agent.id,
- files: [{ tool_resource: 'test_tool', file_id: fileId }],
+ files: [{ tool_resource: EToolResources.execute_code, file_id: fileId }],
}),
);
await Promise.all(promises);
const updatedAgent = await Agent.findOne({ id: agent.id });
- const fileIds = updatedAgent.tool_resources?.test_tool?.file_ids ?? [];
+ const fileIds = updatedAgent?.tool_resources?.[EToolResources.execute_code]?.file_ids ?? [];
expect(fileIds).toHaveLength(expectedLength);
if (expectedContains) {
@@ -284,27 +348,27 @@ describe('models/Agent', () => {
await addAgentResourceFile({
agent_id: agent.id,
- tool_resource: 'test_tool',
+ tool_resource: EToolResources.execute_code,
file_id: fileId,
});
- const operations = [
+ const operations: Promise<IAgent>[] = [
addAgentResourceFile({
agent_id: agent.id,
- tool_resource: 'test_tool',
+ tool_resource: EToolResources.execute_code,
file_id: fileId,
}),
removeAgentResourceFiles({
agent_id: agent.id,
- files: [{ tool_resource: 'test_tool', file_id: fileId }],
+ files: [{ tool_resource: EToolResources.execute_code, file_id: fileId }],
}),
];
await Promise.all(operations);
const updatedAgent = await Agent.findOne({ id: agent.id });
- const finalFileIds = updatedAgent.tool_resources.test_tool.file_ids;
- const count = finalFileIds.filter((id) => id === fileId).length;
+ const finalFileIds = updatedAgent!.tool_resources![EToolResources.execute_code]!.file_ids!;
+ const count = finalFileIds.filter((id: string) => id === fileId).length;
expect(count).toBeLessThanOrEqual(1);
if (count === 0) {
@@ -324,7 +388,7 @@ describe('models/Agent', () => {
fileIds.map((fileId) =>
addAgentResourceFile({
agent_id: agent.id,
- tool_resource: 'test_tool',
+ tool_resource: EToolResources.execute_code,
file_id: fileId,
}),
),
@@ -334,7 +398,7 @@ describe('models/Agent', () => {
const removalPromises = fileIds.map((fileId) =>
removeAgentResourceFiles({
agent_id: agent.id,
- files: [{ tool_resource: 'test_tool', file_id: fileId }],
+ files: [{ tool_resource: EToolResources.execute_code, file_id: fileId }],
}),
);
@@ -342,7 +406,8 @@ describe('models/Agent', () => {
const updatedAgent = await Agent.findOne({ id: agent.id });
// Check if the array is empty or the tool resource itself is removed
- const finalFileIds = updatedAgent.tool_resources?.test_tool?.file_ids ?? [];
+ const finalFileIds =
+ updatedAgent?.tool_resources?.[EToolResources.execute_code]?.file_ids ?? [];
expect(finalFileIds).toHaveLength(0);
});
@@ -366,7 +431,7 @@ describe('models/Agent', () => {
])('addAgentResourceFile with $name', ({ needsAgent, params, shouldResolve, error }) => {
test(`should ${shouldResolve ? 'resolve' : 'reject'}`, async () => {
const agent = needsAgent ? await createBasicAgent() : null;
- const agent_id = needsAgent ? agent.id : `agent_${uuidv4()}`;
+ const agent_id = needsAgent ? agent!.id : `agent_${uuidv4()}`;
if (shouldResolve) {
await expect(addAgentResourceFile({ agent_id, ...params })).resolves.toBeDefined();
@@ -379,7 +444,7 @@ describe('models/Agent', () => {
describe.each([
{
name: 'empty files array',
- files: [],
+ files: [] as { tool_resource: string; file_id: string }[],
needsAgent: true,
shouldResolve: true,
},
@@ -399,7 +464,7 @@ describe('models/Agent', () => {
])('removeAgentResourceFiles with $name', ({ files, needsAgent, shouldResolve, error }) => {
test(`should ${shouldResolve ? 'resolve' : 'reject'}`, async () => {
const agent = needsAgent ? await createBasicAgent() : null;
- const agent_id = needsAgent ? agent.id : `agent_${uuidv4()}`;
+ const agent_id = needsAgent ? agent!.id : `agent_${uuidv4()}`;
if (shouldResolve) {
const result = await removeAgentResourceFiles({ agent_id, files });
@@ -416,36 +481,9 @@ describe('models/Agent', () => {
});
describe('Agent CRUD Operations', () => {
- let mongoServer;
- let AccessRole;
-
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- Agent = mongoose.models.Agent || mongoose.model('Agent', agentSchema);
- await mongoose.connect(mongoUri);
-
- // Initialize models
- const dbModels = require('~/db/models');
- AccessRole = dbModels.AccessRole;
-
- // Create necessary access roles for agents
- await AccessRole.create({
- accessRoleId: AccessRoleIds.AGENT_OWNER,
- name: 'Owner',
- description: 'Full control over agents',
- resourceType: ResourceType.AGENT,
- permBits: 15, // VIEW | EDIT | DELETE | SHARE
- });
- }, 20000);
-
- afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- });
-
beforeEach(async () => {
await Agent.deleteMany({});
+ await User.deleteMany({});
await AclEntry.deleteMany({});
});
@@ -467,9 +505,9 @@ describe('models/Agent', () => {
const retrievedAgent = await getAgent({ id: agentId });
expect(retrievedAgent).toBeDefined();
- expect(retrievedAgent.id).toBe(agentId);
- expect(retrievedAgent.name).toBe('Test Agent');
- expect(retrievedAgent.description).toBe('Test description');
+ expect(retrievedAgent!.id).toBe(agentId);
+ expect(retrievedAgent!.name).toBe('Test Agent');
+ expect(retrievedAgent!.description).toBe('Test description');
});
test('should delete an agent', async () => {
@@ -507,8 +545,9 @@ describe('models/Agent', () => {
});
// Grant permissions (simulating sharing)
- await permissionService.grantPermission({
+ await AclEntry.create({
principalType: PrincipalType.USER,
+ principalModel: PrincipalModel.USER,
principalId: authorId,
resourceType: ResourceType.AGENT,
resourceId: agent._id,
@@ -570,15 +609,15 @@ describe('models/Agent', () => {
// Verify edge exists before deletion
const sourceAgentBefore = await getAgent({ id: sourceAgentId });
- expect(sourceAgentBefore.edges).toHaveLength(1);
- expect(sourceAgentBefore.edges[0].to).toBe(targetAgentId);
+ expect(sourceAgentBefore!.edges).toHaveLength(1);
+ expect(sourceAgentBefore!.edges![0].to).toBe(targetAgentId);
// Delete the target agent
await deleteAgent({ id: targetAgentId });
// Verify the edge is removed from source agent
const sourceAgentAfter = await getAgent({ id: sourceAgentId });
- expect(sourceAgentAfter.edges).toHaveLength(0);
+ expect(sourceAgentAfter!.edges).toHaveLength(0);
});
test('should remove agent from user favorites when agent is deleted', async () => {
@@ -606,8 +645,10 @@ describe('models/Agent', () => {
// Verify user has agent in favorites
const userBefore = await User.findById(userId);
- expect(userBefore.favorites).toHaveLength(2);
- expect(userBefore.favorites.some((f) => f.agentId === agentId)).toBe(true);
+ expect(userBefore!.favorites).toHaveLength(2);
+ expect(
+ userBefore!.favorites!.some((f: Record<string, unknown>) => f.agentId === agentId),
+ ).toBe(true);
// Delete the agent
await deleteAgent({ id: agentId });
@@ -618,9 +659,13 @@ describe('models/Agent', () => {
// Verify agent is removed from user favorites
const userAfter = await User.findById(userId);
- expect(userAfter.favorites).toHaveLength(1);
- expect(userAfter.favorites.some((f) => f.agentId === agentId)).toBe(false);
- expect(userAfter.favorites.some((f) => f.model === 'gpt-4')).toBe(true);
+ expect(userAfter!.favorites).toHaveLength(1);
+ expect(
+ userAfter!.favorites!.some((f: Record<string, unknown>) => f.agentId === agentId),
+ ).toBe(false);
+ expect(userAfter!.favorites!.some((f: Record<string, unknown>) => f.model === 'gpt-4')).toBe(
+ true,
+ );
});
test('should remove agent from multiple users favorites when agent is deleted', async () => {
@@ -662,9 +707,11 @@ describe('models/Agent', () => {
const user1After = await User.findById(user1Id);
const user2After = await User.findById(user2Id);
- expect(user1After.favorites).toHaveLength(0);
- expect(user2After.favorites).toHaveLength(1);
- expect(user2After.favorites.some((f) => f.agentId === agentId)).toBe(false);
+ expect(user1After!.favorites).toHaveLength(0);
+ expect(user2After!.favorites).toHaveLength(1);
+ expect(
+ user2After!.favorites!.some((f: Record<string, unknown>) => f.agentId === agentId),
+ ).toBe(false);
});
test('should preserve other agents in database when one agent is deleted', async () => {
@@ -711,9 +758,9 @@ describe('models/Agent', () => {
const keptAgent1 = await getAgent({ id: agentToKeep1Id });
const keptAgent2 = await getAgent({ id: agentToKeep2Id });
expect(keptAgent1).not.toBeNull();
- expect(keptAgent1.name).toBe('Agent To Keep 1');
+ expect(keptAgent1!.name).toBe('Agent To Keep 1');
expect(keptAgent2).not.toBeNull();
- expect(keptAgent2.name).toBe('Agent To Keep 2');
+ expect(keptAgent2!.name).toBe('Agent To Keep 2');
});
test('should preserve other agents in user favorites when one agent is deleted', async () => {
@@ -763,17 +810,23 @@ describe('models/Agent', () => {
// Verify user has all three agents in favorites
const userBefore = await User.findById(userId);
- expect(userBefore.favorites).toHaveLength(3);
+ expect(userBefore!.favorites).toHaveLength(3);
// Delete one agent
await deleteAgent({ id: agentToDeleteId });
// Verify only the deleted agent is removed from favorites
const userAfter = await User.findById(userId);
- expect(userAfter.favorites).toHaveLength(2);
- expect(userAfter.favorites.some((f) => f.agentId === agentToDeleteId)).toBe(false);
- expect(userAfter.favorites.some((f) => f.agentId === agentToKeep1Id)).toBe(true);
- expect(userAfter.favorites.some((f) => f.agentId === agentToKeep2Id)).toBe(true);
+ expect(userAfter!.favorites).toHaveLength(2);
+ expect(
+ userAfter!.favorites?.some((f: Record<string, unknown>) => f.agentId === agentToDeleteId),
+ ).toBe(false);
+ expect(
+ userAfter!.favorites?.some((f: Record<string, unknown>) => f.agentId === agentToKeep1Id),
+ ).toBe(true);
+ expect(
+ userAfter!.favorites?.some((f: Record<string, unknown>) => f.agentId === agentToKeep2Id),
+ ).toBe(true);
});
test('should not affect users who do not have deleted agent in favorites', async () => {
@@ -823,15 +876,27 @@ describe('models/Agent', () => {
// Verify user with deleted agent has it removed
const userWithDeleted = await User.findById(userWithDeletedAgentId);
- expect(userWithDeleted.favorites).toHaveLength(1);
- expect(userWithDeleted.favorites.some((f) => f.agentId === agentToDeleteId)).toBe(false);
- expect(userWithDeleted.favorites.some((f) => f.model === 'gpt-4')).toBe(true);
+ expect(userWithDeleted!.favorites).toHaveLength(1);
+ expect(
+ userWithDeleted!.favorites!.some(
+ (f: Record<string, unknown>) => f.agentId === agentToDeleteId,
+ ),
+ ).toBe(false);
+ expect(
+ userWithDeleted!.favorites!.some((f: Record<string, unknown>) => f.model === 'gpt-4'),
+ ).toBe(true);
// Verify user without deleted agent is completely unaffected
const userWithoutDeleted = await User.findById(userWithoutDeletedAgentId);
- expect(userWithoutDeleted.favorites).toHaveLength(2);
- expect(userWithoutDeleted.favorites.some((f) => f.agentId === otherAgentId)).toBe(true);
- expect(userWithoutDeleted.favorites.some((f) => f.model === 'claude-3')).toBe(true);
+ expect(userWithoutDeleted!.favorites).toHaveLength(2);
+ expect(
+ userWithoutDeleted!.favorites!.some(
+ (f: Record<string, unknown>) => f.agentId === otherAgentId,
+ ),
+ ).toBe(true);
+ expect(
+ userWithoutDeleted!.favorites!.some((f: Record<string, unknown>) => f.model === 'claude-3'),
+ ).toBe(true);
});
test('should remove all user agents from favorites when deleteUserAgents is called', async () => {
@@ -898,7 +963,7 @@ describe('models/Agent', () => {
});
const userBefore = await User.findById(userId);
- expect(userBefore.favorites).toHaveLength(4);
+ expect(userBefore!.favorites).toHaveLength(4);
await deleteUserAgents(authorId.toString());
@@ -908,11 +973,21 @@ describe('models/Agent', () => {
expect(await getAgent({ id: otherAuthorAgentId })).not.toBeNull();
const userAfter = await User.findById(userId);
- expect(userAfter.favorites).toHaveLength(2);
- expect(userAfter.favorites.some((f) => f.agentId === agent1Id)).toBe(false);
- expect(userAfter.favorites.some((f) => f.agentId === agent2Id)).toBe(false);
- expect(userAfter.favorites.some((f) => f.agentId === otherAuthorAgentId)).toBe(true);
- expect(userAfter.favorites.some((f) => f.model === 'gpt-4')).toBe(true);
+ expect(userAfter!.favorites).toHaveLength(2);
+ expect(
+ userAfter!.favorites!.some((f: Record<string, unknown>) => f.agentId === agent1Id),
+ ).toBe(false);
+ expect(
+ userAfter!.favorites!.some((f: Record<string, unknown>) => f.agentId === agent2Id),
+ ).toBe(false);
+ expect(
+ userAfter!.favorites!.some(
+ (f: Record<string, unknown>) => f.agentId === otherAuthorAgentId,
+ ),
+ ).toBe(true);
+ expect(userAfter!.favorites!.some((f: Record<string, unknown>) => f.model === 'gpt-4')).toBe(
+ true,
+ );
});
test('should handle deleteUserAgents when agents are in multiple users favorites', async () => {
@@ -985,17 +1060,25 @@ describe('models/Agent', () => {
await deleteUserAgents(authorId.toString());
const user1After = await User.findById(user1Id);
- expect(user1After.favorites).toHaveLength(0);
+ expect(user1After!.favorites).toHaveLength(0);
const user2After = await User.findById(user2Id);
- expect(user2After.favorites).toHaveLength(1);
- expect(user2After.favorites.some((f) => f.agentId === agent1Id)).toBe(false);
- expect(user2After.favorites.some((f) => f.model === 'claude-3')).toBe(true);
+ expect(user2After!.favorites).toHaveLength(1);
+ expect(
+ user2After!.favorites!.some((f: Record<string, unknown>) => f.agentId === agent1Id),
+ ).toBe(false);
+ expect(
+ user2After!.favorites!.some((f: Record<string, unknown>) => f.model === 'claude-3'),
+ ).toBe(true);
const user3After = await User.findById(user3Id);
- expect(user3After.favorites).toHaveLength(2);
- expect(user3After.favorites.some((f) => f.agentId === unrelatedAgentId)).toBe(true);
- expect(user3After.favorites.some((f) => f.model === 'gpt-4')).toBe(true);
+ expect(user3After!.favorites).toHaveLength(2);
+ expect(
+ user3After!.favorites!.some((f: Record<string, unknown>) => f.agentId === unrelatedAgentId),
+ ).toBe(true);
+ expect(user3After!.favorites!.some((f: Record<string, unknown>) => f.model === 'gpt-4')).toBe(
+ true,
+ );
});
test('should handle deleteUserAgents when user has no agents', async () => {
@@ -1035,9 +1118,13 @@ describe('models/Agent', () => {
expect(await getAgent({ id: existingAgentId })).not.toBeNull();
const userAfter = await User.findById(userId);
- expect(userAfter.favorites).toHaveLength(2);
- expect(userAfter.favorites.some((f) => f.agentId === existingAgentId)).toBe(true);
- expect(userAfter.favorites.some((f) => f.model === 'gpt-4')).toBe(true);
+ expect(userAfter!.favorites).toHaveLength(2);
+ expect(
+ userAfter!.favorites!.some((f: Record<string, unknown>) => f.agentId === existingAgentId),
+ ).toBe(true);
+ expect(userAfter!.favorites!.some((f: Record<string, unknown>) => f.model === 'gpt-4')).toBe(
+ true,
+ );
});
test('should handle deleteUserAgents when agents are not in any favorites', async () => {
@@ -1097,8 +1184,10 @@ describe('models/Agent', () => {
expect(await getAgent({ id: agent2Id })).toBeNull();
const userAfter = await User.findById(userId);
- expect(userAfter.favorites).toHaveLength(1);
- expect(userAfter.favorites.some((f) => f.model === 'gpt-4')).toBe(true);
+ expect(userAfter!.favorites).toHaveLength(1);
+ expect(userAfter!.favorites!.some((f: Record<string, unknown>) => f.model === 'gpt-4')).toBe(
+ true,
+ );
});
test('should preserve multi-owned agents when deleteUserAgents is called', async () => {
@@ -1124,30 +1213,27 @@ describe('models/Agent', () => {
author: deletingUserId,
});
- await permissionService.grantPermission({
+ await AclEntry.create({
principalType: PrincipalType.USER,
principalId: deletingUserId,
resourceType: ResourceType.AGENT,
- resourceId: soleAgent._id,
- accessRoleId: AccessRoleIds.AGENT_OWNER,
- grantedBy: deletingUserId,
+ resourceId: (soleAgent as unknown as { _id: mongoose.Types.ObjectId })._id,
+ permBits: PermissionBits.DELETE | PermissionBits.READ | PermissionBits.WRITE,
});
- await permissionService.grantPermission({
+ await AclEntry.create({
principalType: PrincipalType.USER,
principalId: deletingUserId,
resourceType: ResourceType.AGENT,
- resourceId: multiAgent._id,
- accessRoleId: AccessRoleIds.AGENT_OWNER,
- grantedBy: deletingUserId,
+ resourceId: (multiAgent as unknown as { _id: mongoose.Types.ObjectId })._id,
+ permBits: PermissionBits.DELETE | PermissionBits.READ | PermissionBits.WRITE,
});
- await permissionService.grantPermission({
+ await AclEntry.create({
principalType: PrincipalType.USER,
principalId: otherOwnerId,
resourceType: ResourceType.AGENT,
- resourceId: multiAgent._id,
- accessRoleId: AccessRoleIds.AGENT_OWNER,
- grantedBy: otherOwnerId,
+ resourceId: (multiAgent as unknown as { _id: mongoose.Types.ObjectId })._id,
+ permBits: PermissionBits.DELETE | PermissionBits.READ | PermissionBits.WRITE,
});
await deleteUserAgents(deletingUserId.toString());
@@ -1157,13 +1243,13 @@ describe('models/Agent', () => {
const soleAcl = await AclEntry.find({
resourceType: ResourceType.AGENT,
- resourceId: soleAgent._id,
+ resourceId: (soleAgent as unknown as { _id: mongoose.Types.ObjectId })._id,
});
expect(soleAcl).toHaveLength(0);
const multiAcl = await AclEntry.find({
resourceType: ResourceType.AGENT,
- resourceId: multiAgent._id,
+ resourceId: (multiAgent as unknown as { _id: mongoose.Types.ObjectId })._id,
principalId: otherOwnerId,
});
expect(multiAcl).toHaveLength(1);
@@ -1171,7 +1257,7 @@ describe('models/Agent', () => {
const deletingUserMultiAcl = await AclEntry.find({
resourceType: ResourceType.AGENT,
- resourceId: multiAgent._id,
+ resourceId: (multiAgent as unknown as { _id: mongoose.Types.ObjectId })._id,
principalId: deletingUserId,
});
expect(deletingUserMultiAcl).toHaveLength(1);
@@ -1194,66 +1280,11 @@ describe('models/Agent', () => {
expect(await getAgent({ id: legacyAgentId })).toBeNull();
});
- test('should handle ephemeral agent loading', async () => {
- const agentId = 'ephemeral_test';
- const endpoint = 'openai';
-
- const originalModule = jest.requireActual('librechat-data-provider');
-
- const mockDataProvider = {
- ...originalModule,
- Constants: {
- ...originalModule.Constants,
- EPHEMERAL_AGENT_ID: 'ephemeral_test',
- },
- };
-
- jest.doMock('librechat-data-provider', () => mockDataProvider);
-
- expect(agentId).toBeDefined();
- expect(endpoint).toBeDefined();
-
- jest.dontMock('librechat-data-provider');
- });
-
- test('should handle loadAgent functionality and errors', async () => {
- const agentId = `agent_${uuidv4()}`;
- const authorId = new mongoose.Types.ObjectId();
-
- await createAgent({
- id: agentId,
- name: 'Test Load Agent',
- provider: 'test',
- model: 'test-model',
- author: authorId,
- tools: ['tool1', 'tool2'],
- });
-
- const agent = await getAgent({ id: agentId });
-
- expect(agent).toBeDefined();
- expect(agent.id).toBe(agentId);
- expect(agent.name).toBe('Test Load Agent');
- expect(agent.tools).toEqual(expect.arrayContaining(['tool1', 'tool2']));
-
- const mockLoadAgent = jest.fn().mockResolvedValue(agent);
- const loadedAgent = await mockLoadAgent();
- expect(loadedAgent).toBeDefined();
- expect(loadedAgent.id).toBe(agentId);
-
- const nonExistentId = `agent_${uuidv4()}`;
- const nonExistentAgent = await getAgent({ id: nonExistentId });
- expect(nonExistentAgent).toBeNull();
-
- const mockLoadAgentError = jest.fn().mockRejectedValue(new Error('No agent found with ID'));
- await expect(mockLoadAgentError()).rejects.toThrow('No agent found with ID');
- });
-
describe('Edge Cases', () => {
test.each([
{
name: 'getAgent with undefined search parameters',
- fn: () => getAgent(undefined),
+ fn: () => getAgent(undefined as unknown as Parameters<typeof getAgent>[0]),
expected: null,
},
{
@@ -1269,20 +1300,6 @@ describe('models/Agent', () => {
});
describe('Agent Version History', () => {
- let mongoServer;
-
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- Agent = mongoose.models.Agent || mongoose.model('Agent', agentSchema);
- await mongoose.connect(mongoUri);
- }, 20000);
-
- afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- });
-
beforeEach(async () => {
await Agent.deleteMany({});
});
@@ -1290,12 +1307,12 @@ describe('models/Agent', () => {
test('should create an agent with a single entry in versions array', async () => {
const agent = await createBasicAgent();
- expect(agent.versions).toBeDefined();
+ expect(agent!.versions).toBeDefined();
expect(Array.isArray(agent.versions)).toBe(true);
- expect(agent.versions).toHaveLength(1);
- expect(agent.versions[0].name).toBe('Test Agent');
- expect(agent.versions[0].provider).toBe('test');
- expect(agent.versions[0].model).toBe('test-model');
+ expect(agent!.versions).toHaveLength(1);
+ expect(agent!.versions![0].name).toBe('Test Agent');
+ expect(agent!.versions![0].provider).toBe('test');
+ expect(agent!.versions![0].model).toBe('test-model');
});
test('should accumulate version history across multiple updates', async () => {
@@ -1317,29 +1334,29 @@ describe('models/Agent', () => {
await updateAgent({ id: agentId }, { name: 'Third Name', model: 'new-model' });
const finalAgent = await updateAgent({ id: agentId }, { description: 'Final description' });
- expect(finalAgent.versions).toBeDefined();
- expect(Array.isArray(finalAgent.versions)).toBe(true);
- expect(finalAgent.versions).toHaveLength(4);
+ expect(finalAgent!.versions).toBeDefined();
+ expect(Array.isArray(finalAgent!.versions)).toBe(true);
+ expect(finalAgent!.versions).toHaveLength(4);
- expect(finalAgent.versions[0].name).toBe('First Name');
- expect(finalAgent.versions[0].description).toBe('First description');
- expect(finalAgent.versions[0].model).toBe('test-model');
+ expect(finalAgent!.versions![0].name).toBe('First Name');
+ expect(finalAgent!.versions![0].description).toBe('First description');
+ expect(finalAgent!.versions![0].model).toBe('test-model');
- expect(finalAgent.versions[1].name).toBe('Second Name');
- expect(finalAgent.versions[1].description).toBe('Second description');
- expect(finalAgent.versions[1].model).toBe('test-model');
+ expect(finalAgent!.versions![1].name).toBe('Second Name');
+ expect(finalAgent!.versions![1].description).toBe('Second description');
+ expect(finalAgent!.versions![1].model).toBe('test-model');
- expect(finalAgent.versions[2].name).toBe('Third Name');
- expect(finalAgent.versions[2].description).toBe('Second description');
- expect(finalAgent.versions[2].model).toBe('new-model');
+ expect(finalAgent!.versions![2].name).toBe('Third Name');
+ expect(finalAgent!.versions![2].description).toBe('Second description');
+ expect(finalAgent!.versions![2].model).toBe('new-model');
- expect(finalAgent.versions[3].name).toBe('Third Name');
- expect(finalAgent.versions[3].description).toBe('Final description');
- expect(finalAgent.versions[3].model).toBe('new-model');
+ expect(finalAgent!.versions![3].name).toBe('Third Name');
+ expect(finalAgent!.versions![3].description).toBe('Final description');
+ expect(finalAgent!.versions![3].model).toBe('new-model');
- expect(finalAgent.name).toBe('Third Name');
- expect(finalAgent.description).toBe('Final description');
- expect(finalAgent.model).toBe('new-model');
+ expect(finalAgent!.name).toBe('Third Name');
+ expect(finalAgent!.description).toBe('Final description');
+ expect(finalAgent!.model).toBe('new-model');
});
test('should not include metadata fields in version history', async () => {
@@ -1354,14 +1371,14 @@ describe('models/Agent', () => {
const updatedAgent = await updateAgent({ id: agentId }, { description: 'New description' });
- expect(updatedAgent.versions).toHaveLength(2);
- expect(updatedAgent.versions[0]._id).toBeUndefined();
- expect(updatedAgent.versions[0].__v).toBeUndefined();
- expect(updatedAgent.versions[0].name).toBe('Test Agent');
- expect(updatedAgent.versions[0].author).toBeUndefined();
+ expect(updatedAgent!.versions).toHaveLength(2);
+ expect(updatedAgent!.versions![0]._id).toBeUndefined();
+ expect((updatedAgent!.versions![0] as VersionEntry).__v).toBeUndefined();
+ expect(updatedAgent!.versions![0].name).toBe('Test Agent');
+ expect(updatedAgent!.versions![0].author).toBeUndefined();
- expect(updatedAgent.versions[1]._id).toBeUndefined();
- expect(updatedAgent.versions[1].__v).toBeUndefined();
+ expect(updatedAgent!.versions![1]._id).toBeUndefined();
+ expect((updatedAgent!.versions![1] as VersionEntry).__v).toBeUndefined();
});
test('should not recursively include previous versions', async () => {
@@ -1378,10 +1395,10 @@ describe('models/Agent', () => {
await updateAgent({ id: agentId }, { name: 'Updated Name 2' });
const finalAgent = await updateAgent({ id: agentId }, { name: 'Updated Name 3' });
- expect(finalAgent.versions).toHaveLength(4);
+ expect(finalAgent!.versions).toHaveLength(4);
- finalAgent.versions.forEach((version) => {
- expect(version.versions).toBeUndefined();
+ finalAgent!.versions!.forEach((version) => {
+ expect((version as VersionEntry).versions).toBeUndefined();
});
});
@@ -1407,10 +1424,10 @@ describe('models/Agent', () => {
);
const firstUpdate = await getAgent({ id: agentId });
- expect(firstUpdate.description).toBe('Updated description');
- expect(firstUpdate.tools).toContain('tool1');
- expect(firstUpdate.tools).toContain('tool2');
- expect(firstUpdate.versions).toHaveLength(2);
+ expect(firstUpdate!.description).toBe('Updated description');
+ expect(firstUpdate!.tools).toContain('tool1');
+ expect(firstUpdate!.tools).toContain('tool2');
+ expect(firstUpdate!.versions).toHaveLength(2);
await updateAgent(
{ id: agentId },
@@ -1420,11 +1437,11 @@ describe('models/Agent', () => {
);
const secondUpdate = await getAgent({ id: agentId });
- expect(secondUpdate.tools).toHaveLength(2);
- expect(secondUpdate.tools).toContain('tool2');
- expect(secondUpdate.tools).toContain('tool3');
- expect(secondUpdate.tools).not.toContain('tool1');
- expect(secondUpdate.versions).toHaveLength(3);
+ expect(secondUpdate!.tools).toHaveLength(2);
+ expect(secondUpdate!.tools).toContain('tool2');
+ expect(secondUpdate!.tools).toContain('tool3');
+ expect(secondUpdate!.tools).not.toContain('tool1');
+ expect(secondUpdate!.versions).toHaveLength(3);
await updateAgent(
{ id: agentId },
@@ -1434,9 +1451,9 @@ describe('models/Agent', () => {
);
const thirdUpdate = await getAgent({ id: agentId });
- const toolCount = thirdUpdate.tools.filter((t) => t === 'tool3').length;
+ const toolCount = thirdUpdate!.tools!.filter((t) => t === 'tool3').length;
expect(toolCount).toBe(2);
- expect(thirdUpdate.versions).toHaveLength(4);
+ expect(thirdUpdate!.versions).toHaveLength(4);
});
test('should handle parameter objects correctly', async () => {
@@ -1457,8 +1474,8 @@ describe('models/Agent', () => {
{ model_parameters: { temperature: 0.8 } },
);
- expect(updatedAgent.versions).toHaveLength(2);
- expect(updatedAgent.model_parameters.temperature).toBe(0.8);
+ expect(updatedAgent!.versions).toHaveLength(2);
+ expect(updatedAgent!.model_parameters?.temperature).toBe(0.8);
await updateAgent(
{ id: agentId },
@@ -1471,15 +1488,15 @@ describe('models/Agent', () => {
);
const complexAgent = await getAgent({ id: agentId });
- expect(complexAgent.versions).toHaveLength(3);
- expect(complexAgent.model_parameters.temperature).toBe(0.8);
- expect(complexAgent.model_parameters.max_tokens).toBe(1000);
+ expect(complexAgent!.versions).toHaveLength(3);
+ expect(complexAgent!.model_parameters?.temperature).toBe(0.8);
+ expect(complexAgent!.model_parameters?.max_tokens).toBe(1000);
await updateAgent({ id: agentId }, { model_parameters: {} });
const emptyParamsAgent = await getAgent({ id: agentId });
- expect(emptyParamsAgent.versions).toHaveLength(4);
- expect(emptyParamsAgent.model_parameters).toEqual({});
+ expect(emptyParamsAgent!.versions).toHaveLength(4);
+ expect(emptyParamsAgent!.model_parameters).toEqual({});
});
test('should not create new version for duplicate updates', async () => {
@@ -1498,15 +1515,15 @@ describe('models/Agent', () => {
});
const updatedAgent = await updateAgent({ id: testAgentId }, testCase.update);
- expect(updatedAgent.versions).toHaveLength(2); // No new version created
+ expect(updatedAgent!.versions).toHaveLength(2); // No new version created
// Update with duplicate data should succeed but not create a new version
const duplicateUpdate = await updateAgent({ id: testAgentId }, testCase.duplicate);
- expect(duplicateUpdate.versions).toHaveLength(2); // No new version created
+ expect(duplicateUpdate!.versions).toHaveLength(2); // No new version created
const agent = await getAgent({ id: testAgentId });
- expect(agent.versions).toHaveLength(2);
+ expect(agent!.versions).toHaveLength(2);
}
});
@@ -1530,9 +1547,11 @@ describe('models/Agent', () => {
{ updatingUserId: updatingUser.toString() },
);
- expect(updatedAgent.versions).toHaveLength(2);
- expect(updatedAgent.versions[1].updatedBy.toString()).toBe(updatingUser.toString());
- expect(updatedAgent.author.toString()).toBe(originalAuthor.toString());
+ expect(updatedAgent!.versions).toHaveLength(2);
+ expect((updatedAgent!.versions![1] as VersionEntry)?.updatedBy?.toString()).toBe(
+ updatingUser.toString(),
+ );
+ expect(updatedAgent!.author.toString()).toBe(originalAuthor.toString());
});
test('should include updatedBy even when the original author updates the agent', async () => {
@@ -1554,9 +1573,11 @@ describe('models/Agent', () => {
{ updatingUserId: originalAuthor.toString() },
);
- expect(updatedAgent.versions).toHaveLength(2);
- expect(updatedAgent.versions[1].updatedBy.toString()).toBe(originalAuthor.toString());
- expect(updatedAgent.author.toString()).toBe(originalAuthor.toString());
+ expect(updatedAgent!.versions).toHaveLength(2);
+ expect((updatedAgent!.versions![1] as VersionEntry)?.updatedBy?.toString()).toBe(
+ originalAuthor.toString(),
+ );
+ expect(updatedAgent!.author.toString()).toBe(originalAuthor.toString());
});
test('should track multiple different users updating the same agent', async () => {
@@ -1603,20 +1624,21 @@ describe('models/Agent', () => {
{ updatingUserId: user3.toString() },
);
- expect(finalAgent.versions).toHaveLength(5);
- expect(finalAgent.author.toString()).toBe(originalAuthor.toString());
+ expect(finalAgent!.versions).toHaveLength(5);
+ expect(finalAgent!.author.toString()).toBe(originalAuthor.toString());
// Check that each version has the correct updatedBy
- expect(finalAgent.versions[0].updatedBy).toBeUndefined(); // Initial creation has no updatedBy
- expect(finalAgent.versions[1].updatedBy.toString()).toBe(user1.toString());
- expect(finalAgent.versions[2].updatedBy.toString()).toBe(originalAuthor.toString());
- expect(finalAgent.versions[3].updatedBy.toString()).toBe(user2.toString());
- expect(finalAgent.versions[4].updatedBy.toString()).toBe(user3.toString());
+ const versions = finalAgent!.versions! as VersionEntry[];
+ expect(versions[0]?.updatedBy).toBeUndefined(); // Initial creation has no updatedBy
+ expect(versions[1]?.updatedBy?.toString()).toBe(user1.toString());
+ expect(versions[2]?.updatedBy?.toString()).toBe(originalAuthor.toString());
+ expect(versions[3]?.updatedBy?.toString()).toBe(user2.toString());
+ expect(versions[4]?.updatedBy?.toString()).toBe(user3.toString());
// Verify the final state
- expect(finalAgent.name).toBe('Updated by User 2');
- expect(finalAgent.description).toBe('Final update by User 3');
- expect(finalAgent.model).toBe('new-model');
+ expect(finalAgent!.name).toBe('Updated by User 2');
+ expect(finalAgent!.description).toBe('Final update by User 3');
+ expect(finalAgent!.model).toBe('new-model');
});
test('should preserve original author during agent restoration', async () => {
@@ -1639,7 +1661,6 @@ describe('models/Agent', () => {
{ updatingUserId: updatingUser.toString() },
);
- const { revertAgentVersion } = require('./Agent');
const revertedAgent = await revertAgentVersion({ id: agentId }, 0);
expect(revertedAgent.author.toString()).toBe(originalAuthor.toString());
@@ -1670,7 +1691,7 @@ describe('models/Agent', () => {
{ updatingUserId: authorId.toString(), forceVersion: true },
);
- expect(firstUpdate.versions).toHaveLength(2);
+ expect(firstUpdate!.versions).toHaveLength(2);
// Second update with same data but forceVersion should still create a version
const secondUpdate = await updateAgent(
@@ -1679,7 +1700,7 @@ describe('models/Agent', () => {
{ updatingUserId: authorId.toString(), forceVersion: true },
);
- expect(secondUpdate.versions).toHaveLength(3);
+ expect(secondUpdate!.versions).toHaveLength(3);
// Update without forceVersion and no changes should not create a version
const duplicateUpdate = await updateAgent(
@@ -1688,7 +1709,7 @@ describe('models/Agent', () => {
{ updatingUserId: authorId.toString(), forceVersion: false },
);
- expect(duplicateUpdate.versions).toHaveLength(3); // No new version created
+ expect(duplicateUpdate!.versions).toHaveLength(3); // No new version created
});
test('should handle isDuplicateVersion with arrays containing null/undefined values', async () => {
@@ -1707,8 +1728,8 @@ describe('models/Agent', () => {
// Update with same array but different null/undefined arrangement
const updatedAgent = await updateAgent({ id: agentId }, { tools: ['tool1', 'tool2'] });
- expect(updatedAgent.versions).toHaveLength(2);
- expect(updatedAgent.tools).toEqual(['tool1', 'tool2']);
+ expect(updatedAgent!.versions).toHaveLength(2);
+ expect(updatedAgent!.tools).toEqual(['tool1', 'tool2']);
});
test('should handle isDuplicateVersion with empty objects in tool_kwargs', async () => {
@@ -1741,7 +1762,7 @@ describe('models/Agent', () => {
);
// Should create new version as order matters for arrays
- expect(updatedAgent.versions).toHaveLength(2);
+ expect(updatedAgent!.versions).toHaveLength(2);
});
test('should handle isDuplicateVersion with mixed primitive and object arrays', async () => {
@@ -1764,7 +1785,7 @@ describe('models/Agent', () => {
);
// Should create new version as types differ
- expect(updatedAgent.versions).toHaveLength(2);
+ expect(updatedAgent!.versions).toHaveLength(2);
});
test('should handle isDuplicateVersion with deeply nested objects', async () => {
@@ -1808,7 +1829,7 @@ describe('models/Agent', () => {
// Since we're updating back to the same model_parameters but with a different description,
// it should create a new version
const agent = await getAgent({ id: agentId });
- expect(agent.versions).toHaveLength(3);
+ expect(agent!.versions).toHaveLength(3);
});
test('should handle version comparison with special field types', async () => {
@@ -1827,7 +1848,7 @@ describe('models/Agent', () => {
// Update with a real field change first
const firstUpdate = await updateAgent({ id: agentId }, { description: 'New description' });
- expect(firstUpdate.versions).toHaveLength(2);
+ expect(firstUpdate!.versions).toHaveLength(2);
// Update with model parameters change
const secondUpdate = await updateAgent(
@@ -1835,7 +1856,7 @@ describe('models/Agent', () => {
{ model_parameters: { temperature: 0.8 } },
);
- expect(secondUpdate.versions).toHaveLength(3);
+ expect(secondUpdate!.versions).toHaveLength(3);
});
test('should detect changes in support_contact fields', async () => {
@@ -1866,9 +1887,9 @@ describe('models/Agent', () => {
},
);
- expect(firstUpdate.versions).toHaveLength(2);
- expect(firstUpdate.support_contact.name).toBe('Updated Support');
- expect(firstUpdate.support_contact.email).toBe('[email protected]');
+ expect(firstUpdate!.versions).toHaveLength(2);
+ expect(firstUpdate!.support_contact?.name).toBe('Updated Support');
+ expect(firstUpdate!.support_contact?.email).toBe('[email protected]');
// Update support_contact email only
const secondUpdate = await updateAgent(
@@ -1881,8 +1902,8 @@ describe('models/Agent', () => {
},
);
- expect(secondUpdate.versions).toHaveLength(3);
- expect(secondUpdate.support_contact.email).toBe('[email protected]');
+ expect(secondUpdate!.versions).toHaveLength(3);
+ expect(secondUpdate!.support_contact?.email).toBe('[email protected]');
// Try to update with same support_contact - should be detected as duplicate but return successfully
const duplicateUpdate = await updateAgent(
@@ -1896,9 +1917,9 @@ describe('models/Agent', () => {
);
// Should not create a new version
- expect(duplicateUpdate.versions).toHaveLength(3);
- expect(duplicateUpdate.version).toBe(3);
- expect(duplicateUpdate.support_contact.email).toBe('[email protected]');
+ expect(duplicateUpdate?.versions).toHaveLength(3);
+ expect((duplicateUpdate as IAgent & { version?: number })?.version).toBe(3);
+ expect(duplicateUpdate?.support_contact?.email).toBe('[email protected]');
});
test('should handle support_contact from empty to populated', async () => {
@@ -1928,9 +1949,9 @@ describe('models/Agent', () => {
},
);
- expect(updated.versions).toHaveLength(2);
- expect(updated.support_contact.name).toBe('New Support Team');
- expect(updated.support_contact.email).toBe('[email protected]');
+ expect(updated?.versions).toHaveLength(2);
+ expect(updated?.support_contact?.name).toBe('New Support Team');
+ expect(updated?.support_contact?.email).toBe('[email protected]');
});
test('should handle support_contact edge cases in isDuplicateVersion', async () => {
@@ -1958,8 +1979,8 @@ describe('models/Agent', () => {
},
);
- expect(emptyUpdate.versions).toHaveLength(2);
- expect(emptyUpdate.support_contact).toEqual({});
+ expect(emptyUpdate?.versions).toHaveLength(2);
+ expect(emptyUpdate?.support_contact).toEqual({});
// Update back to populated support_contact
const repopulated = await updateAgent(
@@ -1972,16 +1993,16 @@ describe('models/Agent', () => {
},
);
- expect(repopulated.versions).toHaveLength(3);
+ expect(repopulated?.versions).toHaveLength(3);
// Verify all versions have correct support_contact
const finalAgent = await getAgent({ id: agentId });
- expect(finalAgent.versions[0].support_contact).toEqual({
+ expect(finalAgent!.versions![0]?.support_contact).toEqual({
name: 'Support',
});
- expect(finalAgent.versions[1].support_contact).toEqual({});
- expect(finalAgent.versions[2].support_contact).toEqual({
+ expect(finalAgent!.versions![1]?.support_contact).toEqual({});
+ expect(finalAgent!.versions![2]?.support_contact).toEqual({
name: 'Support',
});
@@ -2028,22 +2049,22 @@ describe('models/Agent', () => {
const finalAgent = await getAgent({ id: agentId });
// Verify version history
- expect(finalAgent.versions).toHaveLength(3);
- expect(finalAgent.versions[0].support_contact).toEqual({
+ expect(finalAgent!.versions).toHaveLength(3);
+ expect(finalAgent!.versions![0]?.support_contact).toEqual({
name: 'Initial Contact',
});
- expect(finalAgent.versions[1].support_contact).toEqual({
+ expect(finalAgent!.versions![1]?.support_contact).toEqual({
name: 'Second Contact',
});
- expect(finalAgent.versions[2].support_contact).toEqual({
+ expect(finalAgent!.versions![2]?.support_contact).toEqual({
name: 'Third Contact',
});
// Current state should match last version
- expect(finalAgent.support_contact).toEqual({
+ expect(finalAgent!.support_contact).toEqual({
name: 'Third Contact',
});
@@ -2078,9 +2099,9 @@ describe('models/Agent', () => {
},
);
- expect(updated.versions).toHaveLength(2);
- expect(updated.support_contact.name).toBe('New Name');
- expect(updated.support_contact.email).toBe('');
+ expect(updated?.versions).toHaveLength(2);
+ expect(updated?.support_contact?.name).toBe('New Name');
+ expect(updated?.support_contact?.email).toBe('');
// Verify isDuplicateVersion works with partial changes - should return successfully without creating new version
const duplicateUpdate = await updateAgent(
@@ -2094,10 +2115,10 @@ describe('models/Agent', () => {
);
// Should not create a new version since content is the same
- expect(duplicateUpdate.versions).toHaveLength(2);
- expect(duplicateUpdate.version).toBe(2);
- expect(duplicateUpdate.support_contact.name).toBe('New Name');
- expect(duplicateUpdate.support_contact.email).toBe('');
+ expect(duplicateUpdate?.versions).toHaveLength(2);
+ expect((duplicateUpdate as IAgent & { version?: number })?.version).toBe(2);
+ expect(duplicateUpdate?.support_contact?.name).toBe('New Name');
+ expect(duplicateUpdate?.support_contact?.email).toBe('');
});
// Edge Cases
@@ -2120,7 +2141,7 @@ describe('models/Agent', () => {
])('addAgentResourceFile with $name', ({ needsAgent, params, shouldResolve, error }) => {
test(`should ${shouldResolve ? 'resolve' : 'reject'}`, async () => {
const agent = needsAgent ? await createBasicAgent() : null;
- const agent_id = needsAgent ? agent.id : `agent_${uuidv4()}`;
+ const agent_id = needsAgent ? agent!.id : `agent_${uuidv4()}`;
if (shouldResolve) {
await expect(addAgentResourceFile({ agent_id, ...params })).resolves.toBeDefined();
@@ -2153,7 +2174,7 @@ describe('models/Agent', () => {
])('removeAgentResourceFiles with $name', ({ files, needsAgent, shouldResolve, error }) => {
test(`should ${shouldResolve ? 'resolve' : 'reject'}`, async () => {
const agent = needsAgent ? await createBasicAgent() : null;
- const agent_id = needsAgent ? agent.id : `agent_${uuidv4()}`;
+ const agent_id = needsAgent ? agent!.id : `agent_${uuidv4()}`;
if (shouldResolve) {
const result = await removeAgentResourceFiles({ agent_id, files });
@@ -2185,8 +2206,8 @@ describe('models/Agent', () => {
}
const agent = await getAgent({ id: agentId });
- expect(agent.versions).toHaveLength(21);
- expect(agent.description).toBe('Version 19');
+ expect(agent!.versions).toHaveLength(21);
+ expect(agent!.description).toBe('Version 19');
});
test('should handle revertAgentVersion with invalid version index', async () => {
@@ -2227,27 +2248,13 @@ describe('models/Agent', () => {
const updatedAgent = await updateAgent({ id: agentId }, {});
expect(updatedAgent).toBeDefined();
- expect(updatedAgent.name).toBe('Test Agent');
- expect(updatedAgent.versions).toHaveLength(1);
+ expect(updatedAgent!.name).toBe('Test Agent');
+ expect(updatedAgent!.versions).toHaveLength(1);
});
});
});
describe('Action Metadata and Hash Generation', () => {
- let mongoServer;
-
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- Agent = mongoose.models.Agent || mongoose.model('Agent', agentSchema);
- await mongoose.connect(mongoUri);
- }, 20000);
-
- afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- });
-
beforeEach(async () => {
await Agent.deleteMany({});
});
@@ -2415,330 +2422,9 @@ describe('models/Agent', () => {
});
});
- describe('Load Agent Functionality', () => {
- let mongoServer;
-
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- Agent = mongoose.models.Agent || mongoose.model('Agent', agentSchema);
- await mongoose.connect(mongoUri);
- }, 20000);
-
- afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- });
-
- beforeEach(async () => {
- await Agent.deleteMany({});
- });
-
- test('should return null when agent_id is not provided', async () => {
- const mockReq = { user: { id: 'user123' } };
- const result = await loadAgent({
- req: mockReq,
- agent_id: null,
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4' },
- });
-
- expect(result).toBeNull();
- });
-
- test('should return null when agent_id is empty string', async () => {
- const mockReq = { user: { id: 'user123' } };
- const result = await loadAgent({
- req: mockReq,
- agent_id: '',
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4' },
- });
-
- expect(result).toBeNull();
- });
-
- test('should test ephemeral agent loading logic', async () => {
- const { EPHEMERAL_AGENT_ID } = require('librechat-data-provider').Constants;
-
- getCachedTools.mockResolvedValue({
- tool1_mcp_server1: {},
- tool2_mcp_server2: {},
- another_tool: {},
- });
-
- // Mock getMCPServerTools to return tools for each server
- getMCPServerTools.mockImplementation(async (_userId, server) => {
- if (server === 'server1') {
- return { tool1_mcp_server1: {} };
- } else if (server === 'server2') {
- return { tool2_mcp_server2: {} };
- }
- return null;
- });
-
- const mockReq = {
- user: { id: 'user123' },
- body: {
- promptPrefix: 'Test instructions',
- ephemeralAgent: {
- execute_code: true,
- web_search: true,
- mcp: ['server1', 'server2'],
- },
- },
- };
-
- const result = await loadAgent({
- req: mockReq,
- agent_id: EPHEMERAL_AGENT_ID,
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4', temperature: 0.7 },
- });
-
- if (result) {
- // Ephemeral agent ID is encoded with endpoint and model
- expect(result.id).toBe('openai__gpt-4');
- expect(result.instructions).toBe('Test instructions');
- expect(result.provider).toBe('openai');
- expect(result.model).toBe('gpt-4');
- expect(result.model_parameters.temperature).toBe(0.7);
- expect(result.tools).toContain('execute_code');
- expect(result.tools).toContain('web_search');
- expect(result.tools).toContain('tool1_mcp_server1');
- expect(result.tools).toContain('tool2_mcp_server2');
- } else {
- expect(result).toBeNull();
- }
- });
-
- test('should return null for non-existent agent', async () => {
- const mockReq = { user: { id: 'user123' } };
- const result = await loadAgent({
- req: mockReq,
- agent_id: 'agent_non_existent',
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4' },
- });
-
- expect(result).toBeNull();
- });
-
- test('should load agent when user is the author', async () => {
- const userId = new mongoose.Types.ObjectId();
- const agentId = `agent_${uuidv4()}`;
-
- await createAgent({
- id: agentId,
- name: 'Test Agent',
- provider: 'openai',
- model: 'gpt-4',
- author: userId,
- description: 'Test description',
- tools: ['web_search'],
- });
-
- const mockReq = { user: { id: userId.toString() } };
- const result = await loadAgent({
- req: mockReq,
- agent_id: agentId,
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4' },
- });
-
- expect(result).toBeDefined();
- expect(result.id).toBe(agentId);
- expect(result.name).toBe('Test Agent');
- expect(result.author.toString()).toBe(userId.toString());
- expect(result.version).toBe(1);
- });
-
- test('should return agent even when user is not author (permissions checked at route level)', async () => {
- const authorId = new mongoose.Types.ObjectId();
- const userId = new mongoose.Types.ObjectId();
- const agentId = `agent_${uuidv4()}`;
-
- await createAgent({
- id: agentId,
- name: 'Test Agent',
- provider: 'openai',
- model: 'gpt-4',
- author: authorId,
- });
-
- const mockReq = { user: { id: userId.toString() } };
- const result = await loadAgent({
- req: mockReq,
- agent_id: agentId,
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4' },
- });
-
- // With the new permission system, loadAgent returns the agent regardless of permissions
- // Permission checks are handled at the route level via middleware
- expect(result).toBeTruthy();
- expect(result.id).toBe(agentId);
- expect(result.name).toBe('Test Agent');
- });
-
- test('should handle ephemeral agent with no MCP servers', async () => {
- const { EPHEMERAL_AGENT_ID } = require('librechat-data-provider').Constants;
-
- getCachedTools.mockResolvedValue({});
-
- const mockReq = {
- user: { id: 'user123' },
- body: {
- promptPrefix: 'Simple instructions',
- ephemeralAgent: {
- execute_code: false,
- web_search: false,
- mcp: [],
- },
- },
- };
-
- const result = await loadAgent({
- req: mockReq,
- agent_id: EPHEMERAL_AGENT_ID,
- endpoint: 'openai',
- model_parameters: { model: 'gpt-3.5-turbo' },
- });
-
- if (result) {
- expect(result.tools).toEqual([]);
- expect(result.instructions).toBe('Simple instructions');
- } else {
- expect(result).toBeFalsy();
- }
- });
-
- test('should handle ephemeral agent with undefined ephemeralAgent in body', async () => {
- const { EPHEMERAL_AGENT_ID } = require('librechat-data-provider').Constants;
-
- getCachedTools.mockResolvedValue({});
-
- const mockReq = {
- user: { id: 'user123' },
- body: {
- promptPrefix: 'Basic instructions',
- },
- };
-
- const result = await loadAgent({
- req: mockReq,
- agent_id: EPHEMERAL_AGENT_ID,
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4' },
- });
-
- if (result) {
- expect(result.tools).toEqual([]);
- } else {
- expect(result).toBeFalsy();
- }
- });
-
- describe('Edge Cases', () => {
- test('should handle loadAgent with malformed req object', async () => {
- const result = await loadAgent({
- req: null,
- agent_id: 'agent_test',
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4' },
- });
-
- expect(result).toBeNull();
- });
-
- test('should handle ephemeral agent with extremely large tool list', async () => {
- const { EPHEMERAL_AGENT_ID } = require('librechat-data-provider').Constants;
-
- const largeToolList = Array.from({ length: 100 }, (_, i) => `tool_${i}_mcp_server1`);
- const availableTools = largeToolList.reduce((acc, tool) => {
- acc[tool] = {};
- return acc;
- }, {});
-
- getCachedTools.mockResolvedValue(availableTools);
-
- // Mock getMCPServerTools to return all tools for server1
- getMCPServerTools.mockImplementation(async (_userId, server) => {
- if (server === 'server1') {
- return availableTools; // All 100 tools belong to server1
- }
- return null;
- });
-
- const mockReq = {
- user: { id: 'user123' },
- body: {
- promptPrefix: 'Test',
- ephemeralAgent: {
- execute_code: true,
- web_search: true,
- mcp: ['server1'],
- },
- },
- };
-
- const result = await loadAgent({
- req: mockReq,
- agent_id: EPHEMERAL_AGENT_ID,
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4' },
- });
-
- if (result) {
- expect(result.tools.length).toBeGreaterThan(100);
- }
- });
-
- test('should return agent from different project (permissions checked at route level)', async () => {
- const authorId = new mongoose.Types.ObjectId();
- const userId = new mongoose.Types.ObjectId();
- const agentId = `agent_${uuidv4()}`;
-
- await createAgent({
- id: agentId,
- name: 'Project Agent',
- provider: 'openai',
- model: 'gpt-4',
- author: authorId,
- });
-
- const mockReq = { user: { id: userId.toString() } };
- const result = await loadAgent({
- req: mockReq,
- agent_id: agentId,
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4' },
- });
-
- // With the new permission system, loadAgent returns the agent regardless of permissions
- // Permission checks are handled at the route level via middleware
- expect(result).toBeTruthy();
- expect(result.id).toBe(agentId);
- expect(result.name).toBe('Project Agent');
- });
- });
- });
+ /* Load Agent Functionality tests moved to api/models/Agent.spec.js */
describe('Agent Edge Cases and Error Handling', () => {
- let mongoServer;
-
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- Agent = mongoose.models.Agent || mongoose.model('Agent', agentSchema);
- await mongoose.connect(mongoUri);
- }, 20000);
-
- afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- });
-
beforeEach(async () => {
await Agent.deleteMany({});
});
@@ -2757,8 +2443,8 @@ describe('models/Agent', () => {
expect(agent).toBeDefined();
expect(agent.id).toBe(agentId);
expect(agent.versions).toHaveLength(1);
- expect(agent.versions[0].provider).toBe('test');
- expect(agent.versions[0].model).toBe('test-model');
+ expect(agent.versions![0]?.provider).toBe('test');
+ expect(agent.versions![0]?.model).toBe('test-model');
});
test('should handle agent creation with all optional fields', async () => {
@@ -2788,10 +2474,10 @@ describe('models/Agent', () => {
expect(agent.instructions).toBe('Complex instructions');
expect(agent.tools).toEqual(['tool1', 'tool2']);
expect(agent.actions).toEqual(['action1', 'action2']);
- expect(agent.model_parameters.temperature).toBe(0.8);
- expect(agent.model_parameters.max_tokens).toBe(1000);
+ expect(agent.model_parameters?.temperature).toBe(0.8);
+ expect(agent.model_parameters?.max_tokens).toBe(1000);
expect(agent.avatar).toBe('https://example.com/avatar.png');
- expect(agent.tool_resources.file_search.file_ids).toEqual(['file1', 'file2']);
+ expect(agent.tool_resources?.file_search?.file_ids).toEqual(['file1', 'file2']);
});
test('should handle updateAgent with empty update object', async () => {
@@ -2809,8 +2495,8 @@ describe('models/Agent', () => {
const updatedAgent = await updateAgent({ id: agentId }, {});
expect(updatedAgent).toBeDefined();
- expect(updatedAgent.name).toBe('Test Agent');
- expect(updatedAgent.versions).toHaveLength(1); // No new version should be created
+ expect(updatedAgent!.name).toBe('Test Agent');
+ expect(updatedAgent!.versions).toHaveLength(1); // No new version should be created
});
test('should handle concurrent updates to different agents', async () => {
@@ -2840,10 +2526,10 @@ describe('models/Agent', () => {
updateAgent({ id: agent2Id }, { description: 'Updated Agent 2' }),
]);
- expect(updated1.description).toBe('Updated Agent 1');
- expect(updated2.description).toBe('Updated Agent 2');
- expect(updated1.versions).toHaveLength(2);
- expect(updated2.versions).toHaveLength(2);
+ expect(updated1?.description).toBe('Updated Agent 1');
+ expect(updated2?.description).toBe('Updated Agent 2');
+ expect(updated1?.versions).toHaveLength(2);
+ expect(updated2?.versions).toHaveLength(2);
});
test('should handle agent deletion with non-existent ID', async () => {
@@ -2875,10 +2561,10 @@ describe('models/Agent', () => {
},
);
- expect(updatedAgent.name).toBe('Updated Name');
- expect(updatedAgent.tools).toContain('tool1');
- expect(updatedAgent.tools).toContain('tool2');
- expect(updatedAgent.versions).toHaveLength(2);
+ expect(updatedAgent!.name).toBe('Updated Name');
+ expect(updatedAgent!.tools).toContain('tool1');
+ expect(updatedAgent!.tools).toContain('tool2');
+ expect(updatedAgent!.versions).toHaveLength(2);
});
test('should handle revertAgentVersion with invalid version index', async () => {
@@ -2905,11 +2591,9 @@ describe('models/Agent', () => {
test('should handle addAgentResourceFile with non-existent agent', async () => {
const nonExistentId = `agent_${uuidv4()}`;
- const mockReq = { user: { id: 'user123' } };
await expect(
addAgentResourceFile({
- req: mockReq,
agent_id: nonExistentId,
tool_resource: 'file_search',
file_id: 'file123',
@@ -2950,8 +2634,8 @@ describe('models/Agent', () => {
},
);
- expect(firstUpdate.tools).toContain('tool1');
- expect(firstUpdate.tools).toContain('tool2');
+ expect(firstUpdate!.tools).toContain('tool1');
+ expect(firstUpdate!.tools).toContain('tool2');
// Second update with direct field update and $addToSet
const secondUpdate = await updateAgent(
@@ -2963,13 +2647,13 @@ describe('models/Agent', () => {
},
);
- expect(secondUpdate.name).toBe('Updated Agent');
- expect(secondUpdate.model_parameters.temperature).toBe(0.8);
- expect(secondUpdate.model_parameters.max_tokens).toBe(500);
- expect(secondUpdate.tools).toContain('tool1');
- expect(secondUpdate.tools).toContain('tool2');
- expect(secondUpdate.tools).toContain('tool3');
- expect(secondUpdate.versions).toHaveLength(3);
+ expect(secondUpdate!.name).toBe('Updated Agent');
+ expect(secondUpdate!.model_parameters?.temperature).toBe(0.8);
+ expect(secondUpdate!.model_parameters?.max_tokens).toBe(500);
+ expect(secondUpdate!.tools).toContain('tool1');
+ expect(secondUpdate!.tools).toContain('tool2');
+ expect(secondUpdate!.tools).toContain('tool3');
+ expect(secondUpdate!.versions).toHaveLength(3);
});
test('should preserve version order in versions array', async () => {
@@ -2988,12 +2672,12 @@ describe('models/Agent', () => {
await updateAgent({ id: agentId }, { name: 'Version 3' });
const finalAgent = await updateAgent({ id: agentId }, { name: 'Version 4' });
- expect(finalAgent.versions).toHaveLength(4);
- expect(finalAgent.versions[0].name).toBe('Version 1');
- expect(finalAgent.versions[1].name).toBe('Version 2');
- expect(finalAgent.versions[2].name).toBe('Version 3');
- expect(finalAgent.versions[3].name).toBe('Version 4');
- expect(finalAgent.name).toBe('Version 4');
+ expect(finalAgent!.versions).toHaveLength(4);
+ expect(finalAgent!.versions![0]?.name).toBe('Version 1');
+ expect(finalAgent!.versions![1]?.name).toBe('Version 2');
+ expect(finalAgent!.versions![2]?.name).toBe('Version 3');
+ expect(finalAgent!.versions![3]?.name).toBe('Version 4');
+ expect(finalAgent!.name).toBe('Version 4');
});
test('should handle revertAgentVersion properly', async () => {
@@ -3042,8 +2726,8 @@ describe('models/Agent', () => {
);
expect(updatedAgent).toBeDefined();
- expect(updatedAgent.description).toBe('Updated description');
- expect(updatedAgent.versions).toHaveLength(2);
+ expect(updatedAgent!.description).toBe('Updated description');
+ expect(updatedAgent!.versions).toHaveLength(2);
});
test('should handle updateAgent with combined MongoDB operators', async () => {
@@ -3069,10 +2753,10 @@ describe('models/Agent', () => {
);
expect(updatedAgent).toBeDefined();
- expect(updatedAgent.name).toBe('Updated Name');
- expect(updatedAgent.tools).toContain('tool1');
- expect(updatedAgent.tools).toContain('tool2');
- expect(updatedAgent.versions).toHaveLength(2);
+ expect(updatedAgent!.name).toBe('Updated Name');
+ expect(updatedAgent!.tools).toContain('tool1');
+ expect(updatedAgent!.tools).toContain('tool2');
+ expect(updatedAgent!.versions).toHaveLength(2);
});
test('should handle updateAgent when agent does not exist', async () => {
@@ -3153,54 +2837,6 @@ describe('models/Agent', () => {
Agent.findOneAndUpdate = originalFindOneAndUpdate;
});
- test('should handle loadEphemeralAgent with malformed MCP tool names', async () => {
- const { EPHEMERAL_AGENT_ID } = require('librechat-data-provider').Constants;
-
- getCachedTools.mockResolvedValue({
- malformed_tool_name: {}, // No mcp delimiter
- tool__server1: {}, // Wrong delimiter
- tool_mcp_server1: {}, // Correct format
- tool_mcp_server2: {}, // Different server
- });
-
- // Mock getMCPServerTools to return only tools matching the server
- getMCPServerTools.mockImplementation(async (_userId, server) => {
- if (server === 'server1') {
- // Only return tool that correctly matches server1 format
- return { tool_mcp_server1: {} };
- } else if (server === 'server2') {
- return { tool_mcp_server2: {} };
- }
- return null;
- });
-
- const mockReq = {
- user: { id: 'user123' },
- body: {
- promptPrefix: 'Test instructions',
- ephemeralAgent: {
- execute_code: false,
- web_search: false,
- mcp: ['server1'],
- },
- },
- };
-
- const result = await loadAgent({
- req: mockReq,
- agent_id: EPHEMERAL_AGENT_ID,
- endpoint: 'openai',
- model_parameters: { model: 'gpt-4' },
- });
-
- if (result) {
- expect(result.tools).toEqual(['tool_mcp_server1']);
- expect(result.tools).not.toContain('malformed_tool_name');
- expect(result.tools).not.toContain('tool__server1');
- expect(result.tools).not.toContain('tool_mcp_server2');
- }
- });
-
test('should handle addAgentResourceFile when array initialization fails', async () => {
const agentId = `agent_${uuidv4()}`;
const authorId = new mongoose.Types.ObjectId();
@@ -3221,7 +2857,10 @@ describe('models/Agent', () => {
updateOneCalled = true;
return Promise.reject(new Error('Database error'));
}
- return originalUpdateOne.apply(Agent, args);
+ return originalUpdateOne.apply(
+ Agent,
+ args as [update: UpdateQuery<IAgent> | UpdateWithAggregationPipeline],
+ );
});
try {
@@ -3233,8 +2872,8 @@ describe('models/Agent', () => {
expect(result).toBeDefined();
expect(result.tools).toContain('new_tool');
- } catch (error) {
- expect(error.message).toBe('Database error');
+ } catch (error: unknown) {
+ expect((error as Error).message).toBe('Database error');
}
Agent.updateOne = originalUpdateOne;
@@ -3242,20 +2881,6 @@ describe('models/Agent', () => {
});
describe('Agent IDs Field in Version Detection', () => {
- let mongoServer;
-
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- Agent = mongoose.models.Agent || mongoose.model('Agent', agentSchema);
- await mongoose.connect(mongoUri);
- }, 20000);
-
- afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- });
-
beforeEach(async () => {
await Agent.deleteMany({});
});
@@ -3282,8 +2907,8 @@ describe('models/Agent', () => {
);
// Since agent_ids is no longer excluded, this should create a new version
- expect(updated.versions).toHaveLength(2);
- expect(updated.agent_ids).toEqual(['agent1', 'agent2', 'agent3']);
+ expect(updated?.versions).toHaveLength(2);
+ expect(updated?.agent_ids).toEqual(['agent1', 'agent2', 'agent3']);
});
test('should detect duplicate version if agent_ids is updated to same value', async () => {
@@ -3303,14 +2928,14 @@ describe('models/Agent', () => {
{ id: agentId },
{ agent_ids: ['agent1', 'agent2', 'agent3'] },
);
- expect(updatedAgent.versions).toHaveLength(2);
+ expect(updatedAgent!.versions).toHaveLength(2);
// Update with same agent_ids should succeed but not create a new version
const duplicateUpdate = await updateAgent(
{ id: agentId },
{ agent_ids: ['agent1', 'agent2', 'agent3'] },
);
- expect(duplicateUpdate.versions).toHaveLength(2); // No new version created
+ expect(duplicateUpdate?.versions).toHaveLength(2); // No new version created
});
test('should handle agent_ids field alongside other fields', async () => {
@@ -3335,15 +2960,15 @@ describe('models/Agent', () => {
},
);
- expect(updated.versions).toHaveLength(2);
- expect(updated.agent_ids).toEqual(['agent1', 'agent2']);
- expect(updated.description).toBe('Updated description');
+ expect(updated?.versions).toHaveLength(2);
+ expect(updated?.agent_ids).toEqual(['agent1', 'agent2']);
+ expect(updated?.description).toBe('Updated description');
const updated2 = await updateAgent({ id: agentId }, { description: 'Another description' });
- expect(updated2.versions).toHaveLength(3);
- expect(updated2.agent_ids).toEqual(['agent1', 'agent2']);
- expect(updated2.description).toBe('Another description');
+ expect(updated2?.versions).toHaveLength(3);
+ expect(updated2?.agent_ids).toEqual(['agent1', 'agent2']);
+ expect(updated2?.description).toBe('Another description');
});
test('should preserve agent_ids in version history', async () => {
@@ -3365,11 +2990,11 @@ describe('models/Agent', () => {
const finalAgent = await getAgent({ id: agentId });
- expect(finalAgent.versions).toHaveLength(3);
- expect(finalAgent.versions[0].agent_ids).toEqual(['agent1']);
- expect(finalAgent.versions[1].agent_ids).toEqual(['agent1', 'agent2']);
- expect(finalAgent.versions[2].agent_ids).toEqual(['agent3']);
- expect(finalAgent.agent_ids).toEqual(['agent3']);
+ expect(finalAgent!.versions).toHaveLength(3);
+ expect(finalAgent!.versions![0]?.agent_ids).toEqual(['agent1']);
+ expect(finalAgent!.versions![1]?.agent_ids).toEqual(['agent1', 'agent2']);
+ expect(finalAgent!.versions![2]?.agent_ids).toEqual(['agent3']);
+ expect(finalAgent!.agent_ids).toEqual(['agent3']);
});
test('should handle empty agent_ids arrays', async () => {
@@ -3387,13 +3012,13 @@ describe('models/Agent', () => {
const updated = await updateAgent({ id: agentId }, { agent_ids: [] });
- expect(updated.versions).toHaveLength(2);
- expect(updated.agent_ids).toEqual([]);
+ expect(updated?.versions).toHaveLength(2);
+ expect(updated?.agent_ids).toEqual([]);
// Update with same empty agent_ids should succeed but not create a new version
const duplicateUpdate = await updateAgent({ id: agentId }, { agent_ids: [] });
- expect(duplicateUpdate.versions).toHaveLength(2); // No new version created
- expect(duplicateUpdate.agent_ids).toEqual([]);
+ expect(duplicateUpdate?.versions).toHaveLength(2); // No new version created
+ expect(duplicateUpdate?.agent_ids).toEqual([]);
});
test('should handle agent without agent_ids field', async () => {
@@ -3412,27 +3037,13 @@ describe('models/Agent', () => {
const updated = await updateAgent({ id: agentId }, { agent_ids: ['agent1'] });
- expect(updated.versions).toHaveLength(2);
- expect(updated.agent_ids).toEqual(['agent1']);
+ expect(updated?.versions).toHaveLength(2);
+ expect(updated?.agent_ids).toEqual(['agent1']);
});
});
});
describe('Support Contact Field', () => {
- let mongoServer;
-
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- Agent = mongoose.models.Agent || mongoose.model('Agent', agentSchema);
- await mongoose.connect(mongoUri);
- }, 20000);
-
- afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- });
-
beforeEach(async () => {
await Agent.deleteMany({});
});
@@ -3456,18 +3067,18 @@ describe('Support Contact Field', () => {
// Verify support_contact is stored correctly
expect(agent.support_contact).toBeDefined();
- expect(agent.support_contact.name).toBe('Support Team');
- expect(agent.support_contact.email).toBe('[email protected]');
+ expect(agent.support_contact?.name).toBe('Support Team');
+ expect(agent.support_contact?.email).toBe('[email protected]');
// Verify no _id field is created in support_contact
- expect(agent.support_contact._id).toBeUndefined();
+ expect((agent.support_contact as Record<string, unknown>)?._id).toBeUndefined();
// Fetch from database to double-check
const dbAgent = await Agent.findOne({ id: agentData.id });
- expect(dbAgent.support_contact).toBeDefined();
- expect(dbAgent.support_contact.name).toBe('Support Team');
- expect(dbAgent.support_contact.email).toBe('[email protected]');
- expect(dbAgent.support_contact._id).toBeUndefined();
+ expect(dbAgent?.support_contact).toBeDefined();
+ expect(dbAgent?.support_contact?.name).toBe('Support Team');
+ expect(dbAgent?.support_contact?.email).toBe('[email protected]');
+ expect((dbAgent?.support_contact as Record<string, unknown>)?._id).toBeUndefined();
});
it('should handle empty support_contact correctly', async () => {
@@ -3485,7 +3096,7 @@ describe('Support Contact Field', () => {
// Verify empty support_contact is stored as empty object
expect(agent.support_contact).toEqual({});
- expect(agent.support_contact._id).toBeUndefined();
+ expect((agent.support_contact as Record<string, unknown>)?._id).toBeUndefined();
});
it('should handle missing support_contact correctly', async () => {
@@ -3505,11 +3116,12 @@ describe('Support Contact Field', () => {
});
describe('getListAgentsByAccess - Security Tests', () => {
- let userA, userB;
- let agentA1, agentA2, agentA3;
+ let userA: mongoose.Types.ObjectId, userB: mongoose.Types.ObjectId;
+ let agentA1: Awaited<ReturnType<AgentMethods['createAgent']>>,
+ agentA2: Awaited<ReturnType<AgentMethods['createAgent']>>,
+ agentA3: Awaited<ReturnType<AgentMethods['createAgent']>>;
beforeEach(async () => {
- Agent = mongoose.models.Agent || mongoose.model('Agent', agentSchema);
await Agent.deleteMany({});
await AclEntry.deleteMany({});
@@ -3572,7 +3184,7 @@ describe('Support Contact Field', () => {
test('should only return agents in accessibleIds list', async () => {
// Give User B access to only one of User A's agents
- const accessibleIds = [agentA1._id];
+ const accessibleIds = [agentA1._id] as mongoose.Types.ObjectId[];
const result = await getListAgentsByAccess({
accessibleIds,
@@ -3586,7 +3198,7 @@ describe('Support Contact Field', () => {
test('should return multiple accessible agents when provided', async () => {
// Give User B access to two of User A's agents
- const accessibleIds = [agentA1._id, agentA3._id];
+ const accessibleIds = [agentA1._id, agentA3._id] as mongoose.Types.ObjectId[];
const result = await getListAgentsByAccess({
accessibleIds,
@@ -3602,7 +3214,7 @@ describe('Support Contact Field', () => {
test('should respect other query parameters while enforcing accessibleIds', async () => {
// Give access to all agents but filter by name
- const accessibleIds = [agentA1._id, agentA2._id, agentA3._id];
+ const accessibleIds = [agentA1._id, agentA2._id, agentA3._id] as mongoose.Types.ObjectId[];
const result = await getListAgentsByAccess({
accessibleIds,
@@ -3629,7 +3241,9 @@ describe('Support Contact Field', () => {
}
// Give access to all agents
- const allAgentIds = [agentA1, agentA2, agentA3, ...moreAgents].map((a) => a._id);
+ const allAgentIds = [agentA1, agentA2, agentA3, ...moreAgents].map(
+ (a) => a._id,
+ ) as mongoose.Types.ObjectId[];
// First page
const page1 = await getListAgentsByAccess({
@@ -3696,7 +3310,7 @@ describe('Support Contact Field', () => {
});
// Give User B access to one of User A's agents
- const accessibleIds = [agentA1._id, agentB1._id];
+ const accessibleIds = [agentA1._id, agentB1._id] as mongoose.Types.ObjectId[];
// Filter by author should further restrict the results
const result = await getListAgentsByAccess({
@@ -3730,13 +3344,17 @@ function createTestIds() {
};
}
-function createFileOperations(agentId, fileIds, operation = 'add') {
+function createFileOperations(agentId: string, fileIds: string[], operation = 'add') {
return fileIds.map((fileId) =>
operation === 'add'
- ? addAgentResourceFile({ agent_id: agentId, tool_resource: 'test_tool', file_id: fileId })
+ ? addAgentResourceFile({
+ agent_id: agentId,
+ tool_resource: EToolResources.execute_code,
+ file_id: fileId,
+ })
: removeAgentResourceFiles({
agent_id: agentId,
- files: [{ tool_resource: 'test_tool', file_id: fileId }],
+ files: [{ tool_resource: EToolResources.execute_code, file_id: fileId }],
}),
);
}
@@ -3750,7 +3368,14 @@ function mockFindOneAndUpdateError(errorOnCall = 1) {
if (callCount === errorOnCall) {
throw new Error('Database connection lost');
}
- return original.apply(Agent, args);
+ return original.apply(
+ Agent,
+ args as [
+ filter?: RootFilterQuery<IAgent> | undefined,
+ update?: UpdateQuery<IAgent> | undefined,
+ options?: QueryOptions<IAgent> | null | undefined,
+ ],
+ );
});
return () => {
diff --git a/packages/data-schemas/src/methods/agent.ts b/packages/data-schemas/src/methods/agent.ts
new file mode 100644
index 0000000000..43147eaea9
--- /dev/null
+++ b/packages/data-schemas/src/methods/agent.ts
@@ -0,0 +1,762 @@
+import crypto from 'node:crypto';
+import type { FilterQuery, Model, Types } from 'mongoose';
+import { Constants, ResourceType, actionDelimiter } from 'librechat-data-provider';
+import logger from '~/config/winston';
+import type { IAgent } from '~/types';
+
+const { mcp_delimiter } = Constants;
+
+export interface AgentDeps {
+ /** Removes all ACL permissions for a resource. Injected from PermissionService. */
+ removeAllPermissions: (params: { resourceType: string; resourceId: unknown }) => Promise<void>;
+ /** Gets actions. Created by createActionMethods. */
+ getActions: (
+ searchParams: FilterQuery<unknown>,
+ includeSensitive?: boolean,
+ ) => Promise<unknown[]>;
+ /** Returns resource IDs solely owned by the given user. From createAclEntryMethods. */
+ getSoleOwnedResourceIds: (
+ userObjectId: Types.ObjectId,
+ resourceTypes: string | string[],
+ ) => Promise<Types.ObjectId[]>;
+}
+
+/**
+ * Extracts unique MCP server names from tools array.
+ * Tools format: "toolName_mcp_serverName" or "sys__server__sys_mcp_serverName"
+ */
+function extractMCPServerNames(tools: string[] | undefined | null): string[] {
+ if (!tools || !Array.isArray(tools)) {
+ return [];
+ }
+ const serverNames = new Set<string>();
+ for (const tool of tools) {
+ if (!tool || !tool.includes(mcp_delimiter)) {
+ continue;
+ }
+ const parts = tool.split(mcp_delimiter);
+ if (parts.length >= 2) {
+ serverNames.add(parts[parts.length - 1]);
+ }
+ }
+ return Array.from(serverNames);
+}
+
+/**
+ * Check if a version already exists in the versions array, excluding timestamp and author fields.
+ */
+function isDuplicateVersion(
+ updateData: Record<string, unknown>,
+ currentData: Record<string, unknown>,
+ versions: Record<string, unknown>[],
+ actionsHash: string | null = null,
+): Record<string, unknown> | null {
+ if (!versions || versions.length === 0) {
+ return null;
+ }
+
+ const excludeFields = [
+ '_id',
+ 'id',
+ 'createdAt',
+ 'updatedAt',
+ 'author',
+ 'updatedBy',
+ 'created_at',
+ 'updated_at',
+ '__v',
+ 'versions',
+ 'actionsHash',
+ ];
+
+ const { $push: _$push, $pull: _$pull, $addToSet: _$addToSet, ...directUpdates } = updateData;
+
+ if (Object.keys(directUpdates).length === 0 && !actionsHash) {
+ return null;
+ }
+
+ const wouldBeVersion = { ...currentData, ...directUpdates } as Record<string, unknown>;
+ const lastVersion = versions[versions.length - 1] as Record<string, unknown>;
+
+ if (actionsHash && lastVersion.actionsHash !== actionsHash) {
+ return null;
+ }
+
+ const allFields = new Set([...Object.keys(wouldBeVersion), ...Object.keys(lastVersion)]);
+ const importantFields = Array.from(allFields).filter((field) => !excludeFields.includes(field));
+
+ let isMatch = true;
+ for (const field of importantFields) {
+ const wouldBeValue = wouldBeVersion[field];
+ const lastVersionValue = lastVersion[field];
+
+ if (!wouldBeValue && !lastVersionValue) {
+ continue;
+ }
+
+ // Handle arrays
+ if (Array.isArray(wouldBeValue) || Array.isArray(lastVersionValue)) {
+ let wouldBeArr: unknown[];
+ if (Array.isArray(wouldBeValue)) {
+ wouldBeArr = wouldBeValue;
+ } else if (wouldBeValue == null) {
+ wouldBeArr = [];
+ } else {
+ wouldBeArr = [wouldBeValue];
+ }
+
+ let lastVersionArr: unknown[];
+ if (Array.isArray(lastVersionValue)) {
+ lastVersionArr = lastVersionValue;
+ } else if (lastVersionValue == null) {
+ lastVersionArr = [];
+ } else {
+ lastVersionArr = [lastVersionValue];
+ }
+
+ if (wouldBeArr.length !== lastVersionArr.length) {
+ isMatch = false;
+ break;
+ }
+
+ if (wouldBeArr.length > 0 && typeof wouldBeArr[0] === 'object' && wouldBeArr[0] !== null) {
+ const sortedWouldBe = [...wouldBeArr].map((item) => JSON.stringify(item)).sort();
+ const sortedVersion = [...lastVersionArr].map((item) => JSON.stringify(item)).sort();
+
+ if (!sortedWouldBe.every((item, i) => item === sortedVersion[i])) {
+ isMatch = false;
+ break;
+ }
+ } else {
+ const sortedWouldBe = [...wouldBeArr].sort() as string[];
+ const sortedVersion = [...lastVersionArr].sort() as string[];
+
+ if (!sortedWouldBe.every((item, i) => item === sortedVersion[i])) {
+ isMatch = false;
+ break;
+ }
+ }
+ }
+ // Handle objects
+ else if (typeof wouldBeValue === 'object' && wouldBeValue !== null) {
+ const lastVersionObj =
+ typeof lastVersionValue === 'object' && lastVersionValue !== null ? lastVersionValue : {};
+
+ const wouldBeKeys = Object.keys(wouldBeValue as Record<string, unknown>);
+ const lastVersionKeys = Object.keys(lastVersionObj as Record<string, unknown>);
+
+ if (wouldBeKeys.length === 0 && lastVersionKeys.length === 0) {
+ continue;
+ }
+
+ if (JSON.stringify(wouldBeValue) !== JSON.stringify(lastVersionObj)) {
+ isMatch = false;
+ break;
+ }
+ }
+ // Handle primitive values
+ else {
+ if (wouldBeValue !== lastVersionValue) {
+ if (
+ typeof wouldBeValue === 'boolean' &&
+ wouldBeValue === false &&
+ lastVersionValue === undefined
+ ) {
+ continue;
+ }
+ if (
+ typeof wouldBeValue === 'string' &&
+ wouldBeValue === '' &&
+ lastVersionValue === undefined
+ ) {
+ continue;
+ }
+ isMatch = false;
+ break;
+ }
+ }
+ }
+
+ return isMatch ? lastVersion : null;
+}
+
+/**
+ * Generates a hash of action metadata for version comparison.
+ */
+async function generateActionMetadataHash(
+ actionIds: string[] | null | undefined,
+ actions: Array<{ action_id: string; metadata: Record<string, unknown> | null }>,
+): Promise<string> {
+ if (!actionIds || actionIds.length === 0) {
+ return '';
+ }
+
+ const actionMap = new Map<string, Record<string, unknown> | null>();
+ actions.forEach((action) => {
+ actionMap.set(action.action_id, action.metadata);
+ });
+
+ const sortedActionIds = [...actionIds].sort();
+
+ const metadataString = sortedActionIds
+ .map((actionFullId) => {
+ const parts = actionFullId.split(actionDelimiter);
+ const actionId = parts[1];
+
+ const metadata = actionMap.get(actionId);
+ if (!metadata) {
+ return `${actionId}:null`;
+ }
+
+ const sortedKeys = Object.keys(metadata).sort();
+ const metadataStr = sortedKeys
+ .map((key) => `${key}:${JSON.stringify(metadata[key])}`)
+ .join(',');
+ return `${actionId}:{${metadataStr}}`;
+ })
+ .join(';');
+
+ const encoder = new TextEncoder();
+ const data = encoder.encode(metadataString);
+ const hashBuffer = await crypto.webcrypto.subtle.digest('SHA-256', data);
+ const hashArray = Array.from(new Uint8Array(hashBuffer));
+ const hashHex = hashArray.map((b) => b.toString(16).padStart(2, '0')).join('');
+
+ return hashHex;
+}
+
+export function createAgentMethods(mongoose: typeof import('mongoose'), deps: AgentDeps) {
+ const { removeAllPermissions, getActions, getSoleOwnedResourceIds } = deps;
+
+ /**
+ * Create an agent with the provided data.
+ */
+ async function createAgent(agentData: Record<string, unknown>): Promise<IAgent> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ const { author: _author, ...versionData } = agentData;
+ const timestamp = new Date();
+ const initialAgentData = {
+ ...agentData,
+ versions: [
+ {
+ ...versionData,
+ createdAt: timestamp,
+ updatedAt: timestamp,
+ },
+ ],
+ category: (agentData.category as string) || 'general',
+ mcpServerNames: extractMCPServerNames(agentData.tools as string[] | undefined),
+ };
+
+ return (await Agent.create(initialAgentData)).toObject() as IAgent;
+ }
+
+ /**
+ * Get an agent document based on the provided search parameter.
+ */
+ async function getAgent(searchParameter: FilterQuery<IAgent>): Promise<IAgent | null> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ return (await Agent.findOne(searchParameter).lean()) as IAgent | null;
+ }
+
+ /**
+ * Get multiple agent documents based on the provided search parameters.
+ */
+ async function getAgents(searchParameter: FilterQuery<IAgent>): Promise<IAgent[]> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ return (await Agent.find(searchParameter).lean()) as IAgent[];
+ }
+
+ /**
+ * Update an agent with new data without overwriting existing properties,
+ * or create a new agent if it doesn't exist.
+ * When an agent is updated, a copy of the current state will be saved to the versions array.
+ */
+ async function updateAgent(
+ searchParameter: FilterQuery<IAgent>,
+ updateData: Record<string, unknown>,
+ options: {
+ updatingUserId?: string | null;
+ forceVersion?: boolean;
+ skipVersioning?: boolean;
+ } = {},
+ ): Promise<IAgent | null> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ const { updatingUserId = null, forceVersion = false, skipVersioning = false } = options;
+ const mongoOptions = { new: true, upsert: false };
+
+ const currentAgent = await Agent.findOne(searchParameter);
+ if (currentAgent) {
+ const {
+ __v,
+ _id,
+ id: __id,
+ versions,
+ author: _author,
+ ...versionData
+ } = currentAgent.toObject() as unknown as Record<string, unknown>;
+ const { $push, $pull, $addToSet, ...directUpdates } = updateData;
+
+ // Sync mcpServerNames when tools are updated
+ if ((directUpdates as Record<string, unknown>).tools !== undefined) {
+ const mcpServerNames = extractMCPServerNames(
+ (directUpdates as Record<string, unknown>).tools as string[],
+ );
+ (directUpdates as Record<string, unknown>).mcpServerNames = mcpServerNames;
+ updateData.mcpServerNames = mcpServerNames;
+ }
+
+ let actionsHash: string | null = null;
+
+ // Generate actions hash if agent has actions
+ if (currentAgent.actions && currentAgent.actions.length > 0) {
+ const actionIds = currentAgent.actions
+ .map((action: string) => {
+ const parts = action.split(actionDelimiter);
+ return parts[1];
+ })
+ .filter(Boolean);
+
+ if (actionIds.length > 0) {
+ try {
+ const actions = await getActions({ action_id: { $in: actionIds } }, true);
+
+ actionsHash = await generateActionMetadataHash(
+ currentAgent.actions,
+ actions as Array<{ action_id: string; metadata: Record<string, unknown> | null }>,
+ );
+ } catch (error) {
+ logger.error('Error fetching actions for hash generation:', error);
+ }
+ }
+ }
+
+ const shouldCreateVersion =
+ !skipVersioning &&
+ (forceVersion || Object.keys(directUpdates).length > 0 || $push || $pull || $addToSet);
+
+ if (shouldCreateVersion) {
+ const duplicateVersion = isDuplicateVersion(
+ updateData,
+ versionData,
+ versions as Record<string, unknown>[],
+ actionsHash,
+ );
+ if (duplicateVersion && !forceVersion) {
+ const agentObj = currentAgent.toObject() as IAgent & {
+ version?: number;
+ versions?: unknown[];
+ };
+ agentObj.version = (versions as unknown[]).length;
+ return agentObj;
+ }
+ }
+
+ const versionEntry: Record<string, unknown> = {
+ ...versionData,
+ ...directUpdates,
+ updatedAt: new Date(),
+ };
+
+ if (actionsHash) {
+ versionEntry.actionsHash = actionsHash;
+ }
+
+ if (updatingUserId) {
+ versionEntry.updatedBy = new mongoose.Types.ObjectId(updatingUserId);
+ }
+
+ if (shouldCreateVersion) {
+ updateData.$push = {
+ ...(($push as Record<string, unknown>) || {}),
+ versions: versionEntry,
+ };
+ }
+ }
+
+ return (await Agent.findOneAndUpdate(
+ searchParameter,
+ updateData,
+ mongoOptions,
+ ).lean()) as IAgent | null;
+ }
+
+ /**
+ * Modifies an agent with the resource file id.
+ */
+ async function addAgentResourceFile({
+ agent_id,
+ tool_resource,
+ file_id,
+ updatingUserId,
+ }: {
+ agent_id: string;
+ tool_resource: string;
+ file_id: string;
+ updatingUserId?: string;
+ }): Promise<IAgent> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ const searchParameter = { id: agent_id };
+ const agent = await getAgent(searchParameter);
+ if (!agent) {
+ throw new Error('Agent not found for adding resource file');
+ }
+ const fileIdsPath = `tool_resources.${tool_resource}.file_ids`;
+ await Agent.updateOne(
+ {
+ id: agent_id,
+ [`${fileIdsPath}`]: { $exists: false },
+ },
+ {
+ $set: {
+ [`${fileIdsPath}`]: [],
+ },
+ },
+ );
+
+ const updateDataObj: Record<string, unknown> = {
+ $addToSet: {
+ tools: tool_resource,
+ [fileIdsPath]: file_id,
+ },
+ };
+
+ const updatedAgent = await updateAgent(searchParameter, updateDataObj, {
+ updatingUserId,
+ });
+ if (updatedAgent) {
+ return updatedAgent;
+ } else {
+ throw new Error('Agent not found for adding resource file');
+ }
+ }
+
+ /**
+ * Removes multiple resource files from an agent using atomic operations.
+ */
+ async function removeAgentResourceFiles({
+ agent_id,
+ files,
+ }: {
+ agent_id: string;
+ files: Array<{ tool_resource: string; file_id: string }>;
+ }): Promise<IAgent> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ const searchParameter = { id: agent_id };
+
+ const filesByResource = files.reduce(
+ (acc: Record<string, string[]>, { tool_resource, file_id }) => {
+ if (!acc[tool_resource]) {
+ acc[tool_resource] = [];
+ }
+ acc[tool_resource].push(file_id);
+ return acc;
+ },
+ {},
+ );
+
+ const pullAllOps: Record<string, string[]> = {};
+ for (const [resource, fileIds] of Object.entries(filesByResource)) {
+ const fileIdsPath = `tool_resources.${resource}.file_ids`;
+ pullAllOps[fileIdsPath] = fileIds;
+ }
+
+ const updatePullData = { $pullAll: pullAllOps };
+ const agentAfterPull = (await Agent.findOneAndUpdate(searchParameter, updatePullData, {
+ new: true,
+ }).lean()) as IAgent | null;
+
+ if (!agentAfterPull) {
+ const agentExists = await getAgent(searchParameter);
+ if (!agentExists) {
+ throw new Error('Agent not found for removing resource files');
+ }
+ throw new Error('Failed to update agent during file removal (pull step)');
+ }
+
+ return agentAfterPull;
+ }
+
+ /**
+ * Deletes an agent based on the provided search parameter.
+ */
+ async function deleteAgent(searchParameter: FilterQuery<IAgent>): Promise<IAgent | null> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ const User = mongoose.models.User as Model<unknown>;
+ const agent = await Agent.findOneAndDelete(searchParameter);
+ if (agent) {
+ await Promise.all([
+ removeAllPermissions({
+ resourceType: ResourceType.AGENT,
+ resourceId: agent._id,
+ }),
+ removeAllPermissions({
+ resourceType: ResourceType.REMOTE_AGENT,
+ resourceId: agent._id,
+ }),
+ ]);
+ try {
+ await Agent.updateMany(
+ { 'edges.to': (agent as unknown as { id: string }).id },
+ { $pull: { edges: { to: (agent as unknown as { id: string }).id } } },
+ );
+ } catch (error) {
+ logger.error('[deleteAgent] Error removing agent from handoff edges', error);
+ }
+ try {
+ await User.updateMany(
+ { 'favorites.agentId': (agent as unknown as { id: string }).id },
+ { $pull: { favorites: { agentId: (agent as unknown as { id: string }).id } } },
+ );
+ } catch (error) {
+ logger.error('[deleteAgent] Error removing agent from user favorites', error);
+ }
+ }
+ return agent ? (agent.toObject() as IAgent) : null;
+ }
+
+ /**
+ * Deletes agents solely owned by the user and cleans up their ACLs.
+ * Agents with other owners are left intact; the caller is responsible for
+ * removing the user's own ACL principal entries separately.
+ *
+ * Also handles legacy (pre-ACL) agents that only have the author field set,
+ * ensuring they are not orphaned if no permission migration has been run.
+ */
+ async function deleteUserAgents(userId: string): Promise<void> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ const AclEntry = mongoose.models.AclEntry as Model<unknown>;
+ const User = mongoose.models.User as Model<unknown>;
+
+ try {
+ const userObjectId = new mongoose.Types.ObjectId(userId);
+ const soleOwnedObjectIds = await getSoleOwnedResourceIds(userObjectId, [
+ ResourceType.AGENT,
+ ResourceType.REMOTE_AGENT,
+ ]);
+
+ const authoredAgents = await Agent.find({ author: userObjectId }).select('id _id').lean();
+
+ const migratedEntries =
+ authoredAgents.length > 0
+ ? await AclEntry.find({
+ resourceType: { $in: [ResourceType.AGENT, ResourceType.REMOTE_AGENT] },
+ resourceId: { $in: authoredAgents.map((a) => a._id) },
+ })
+ .select('resourceId')
+ .lean()
+ : [];
+ const migratedIds = new Set(
+ (migratedEntries as Array<{ resourceId: Types.ObjectId }>).map((e) => e.resourceId.toString()),
+ );
+ const legacyAgents = authoredAgents.filter((a) => !migratedIds.has(a._id.toString()));
+
+ const soleOwnedAgents =
+ soleOwnedObjectIds.length > 0
+ ? await Agent.find({ _id: { $in: soleOwnedObjectIds } })
+ .select('id _id')
+ .lean()
+ : [];
+
+ const allAgents = [...soleOwnedAgents, ...legacyAgents];
+
+ if (allAgents.length === 0) {
+ return;
+ }
+
+ const agentIds = allAgents.map((agent) => agent.id);
+ const agentObjectIds = allAgents.map((agent) => agent._id);
+
+ await AclEntry.deleteMany({
+ resourceType: { $in: [ResourceType.AGENT, ResourceType.REMOTE_AGENT] },
+ resourceId: { $in: agentObjectIds },
+ });
+
+ try {
+ await Agent.updateMany(
+ { 'edges.to': { $in: agentIds } },
+ { $pull: { edges: { to: { $in: agentIds } } } },
+ );
+ } catch (error) {
+ logger.error('[deleteUserAgents] Error removing agents from handoff edges', error);
+ }
+
+ try {
+ await User.updateMany(
+ { 'favorites.agentId': { $in: agentIds } },
+ { $pull: { favorites: { agentId: { $in: agentIds } } } },
+ );
+ } catch (error) {
+ logger.error('[deleteUserAgents] Error removing agents from user favorites', error);
+ }
+
+ await Agent.deleteMany({ _id: { $in: agentObjectIds } });
+ } catch (error) {
+ logger.error('[deleteUserAgents] General error:', error);
+ }
+ }
+
+ /**
+ * Get agents by accessible IDs with optional cursor-based pagination.
+ */
+ async function getListAgentsByAccess({
+ accessibleIds = [],
+ otherParams = {},
+ limit = null,
+ after = null,
+ }: {
+ accessibleIds?: Types.ObjectId[];
+ otherParams?: Record<string, unknown>;
+ limit?: number | null;
+ after?: string | null;
+ }): Promise<{
+ object: string;
+ data: Array<Record<string, unknown>>;
+ first_id: string | null;
+ last_id: string | null;
+ has_more: boolean;
+ after: string | null;
+ }> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ const isPaginated = limit !== null && limit !== undefined;
+ const normalizedLimit = isPaginated
+ ? Math.min(Math.max(1, parseInt(String(limit)) || 20), 100)
+ : null;
+
+ const baseQuery: Record<string, unknown> = {
+ ...otherParams,
+ _id: { $in: accessibleIds },
+ };
+
+ if (after) {
+ try {
+ const cursor = JSON.parse(Buffer.from(after, 'base64').toString('utf8'));
+ const { updatedAt, _id } = cursor;
+
+ const cursorCondition = {
+ $or: [
+ { updatedAt: { $lt: new Date(updatedAt) } },
+ {
+ updatedAt: new Date(updatedAt),
+ _id: { $gt: new mongoose.Types.ObjectId(_id) },
+ },
+ ],
+ };
+
+ if (Object.keys(baseQuery).length > 0) {
+ baseQuery.$and = [{ ...baseQuery }, cursorCondition];
+ Object.keys(baseQuery).forEach((key) => {
+ if (key !== '$and') delete baseQuery[key];
+ });
+ } else {
+ Object.assign(baseQuery, cursorCondition);
+ }
+ } catch (error) {
+ logger.warn('Invalid cursor:', (error as Error).message);
+ }
+ }
+
+ let query = Agent.find(baseQuery, {
+ id: 1,
+ _id: 1,
+ name: 1,
+ avatar: 1,
+ author: 1,
+ description: 1,
+ updatedAt: 1,
+ category: 1,
+ support_contact: 1,
+ is_promoted: 1,
+ }).sort({ updatedAt: -1, _id: 1 });
+
+ if (isPaginated && normalizedLimit) {
+ query = query.limit(normalizedLimit + 1);
+ }
+
+ const agents = (await query.lean()) as Array<Record<string, unknown>>;
+
+ const hasMore = isPaginated && normalizedLimit ? agents.length > normalizedLimit : false;
+ const data = (isPaginated && normalizedLimit ? agents.slice(0, normalizedLimit) : agents).map(
+ (agent) => {
+ if (agent.author) {
+ agent.author = (agent.author as Types.ObjectId).toString();
+ }
+ return agent;
+ },
+ );
+
+ let nextCursor: string | null = null;
+ if (isPaginated && hasMore && data.length > 0 && normalizedLimit) {
+ const lastAgent = agents[normalizedLimit - 1];
+ nextCursor = Buffer.from(
+ JSON.stringify({
+ updatedAt: (lastAgent.updatedAt as Date).toISOString(),
+ _id: (lastAgent._id as Types.ObjectId).toString(),
+ }),
+ ).toString('base64');
+ }
+
+ return {
+ object: 'list',
+ data,
+ first_id: data.length > 0 ? (data[0].id as string) : null,
+ last_id: data.length > 0 ? (data[data.length - 1].id as string) : null,
+ has_more: hasMore,
+ after: nextCursor,
+ };
+ }
+
+ /**
+ * Reverts an agent to a specific version in its version history.
+ */
+ async function revertAgentVersion(
+ searchParameter: FilterQuery<IAgent>,
+ versionIndex: number,
+ ): Promise<IAgent> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ const agent = await Agent.findOne(searchParameter);
+ if (!agent) {
+ throw new Error('Agent not found');
+ }
+
+ if (!agent.versions || !agent.versions[versionIndex]) {
+ throw new Error(`Version ${versionIndex} not found`);
+ }
+
+ const revertToVersion = { ...(agent.versions[versionIndex] as Record<string, unknown>) };
+ delete revertToVersion._id;
+ delete revertToVersion.id;
+ delete revertToVersion.versions;
+ delete revertToVersion.author;
+ delete revertToVersion.updatedBy;
+
+ return (await Agent.findOneAndUpdate(searchParameter, revertToVersion, {
+ new: true,
+ }).lean()) as IAgent;
+ }
+
+ /**
+ * Counts the number of promoted agents.
+ */
+ async function countPromotedAgents(): Promise<number> {
+ const Agent = mongoose.models.Agent as Model<IAgent>;
+ return await Agent.countDocuments({ is_promoted: true });
+ }
+
+ return {
+ createAgent,
+ getAgent,
+ getAgents,
+ updateAgent,
+ deleteAgent,
+ deleteUserAgents,
+ revertAgentVersion,
+ countPromotedAgents,
+ addAgentResourceFile,
+ removeAgentResourceFiles,
+ getListAgentsByAccess,
+ generateActionMetadataHash,
+ };
+}
+
+export type AgentMethods = ReturnType<typeof createAgentMethods>;
diff --git a/packages/data-schemas/src/methods/assistant.ts b/packages/data-schemas/src/methods/assistant.ts
new file mode 100644
index 0000000000..79133d4237
--- /dev/null
+++ b/packages/data-schemas/src/methods/assistant.ts
@@ -0,0 +1,69 @@
+import type { FilterQuery, Model } from 'mongoose';
+import type { IAssistant } from '~/types';
+
+export function createAssistantMethods(mongoose: typeof import('mongoose')) {
+ /**
+ * Update an assistant with new data without overwriting existing properties,
+ * or create a new assistant if it doesn't exist.
+ */
+ async function updateAssistantDoc(
+ searchParams: FilterQuery<IAssistant>,
+ updateData: Partial<IAssistant>,
+ ): Promise<IAssistant | null> {
+ const Assistant = mongoose.models.Assistant as Model<IAssistant>;
+ const options = { new: true, upsert: true };
+ return (await Assistant.findOneAndUpdate(
+ searchParams,
+ updateData,
+ options,
+ ).lean()) as IAssistant | null;
+ }
+
+ /**
+ * Retrieves an assistant document based on the provided search params.
+ */
+ async function getAssistant(searchParams: FilterQuery<IAssistant>): Promise<IAssistant | null> {
+ const Assistant = mongoose.models.Assistant as Model<IAssistant>;
+ return (await Assistant.findOne(searchParams).lean()) as IAssistant | null;
+ }
+
+ /**
+ * Retrieves all assistants that match the given search parameters.
+ */
+ async function getAssistants(
+ searchParams: FilterQuery<IAssistant>,
+ select: string | Record<string, number> | null = null,
+ ): Promise<IAssistant[]> {
+ const Assistant = mongoose.models.Assistant as Model<IAssistant>;
+ const query = Assistant.find(searchParams);
+
+ return (await (select ? query.select(select) : query).lean()) as IAssistant[];
+ }
+
+ /**
+ * Deletes an assistant based on the provided search params.
+ */
+ async function deleteAssistant(searchParams: FilterQuery<IAssistant>) {
+ const Assistant = mongoose.models.Assistant as Model<IAssistant>;
+ return await Assistant.findOneAndDelete(searchParams);
+ }
+
+ /**
+ * Deletes all assistants matching the given search parameters.
+ */
+ async function deleteAssistants(searchParams: FilterQuery<IAssistant>): Promise<number> {
+ const Assistant = mongoose.models.Assistant as Model<IAssistant>;
+ const result = await Assistant.deleteMany(searchParams);
+ return result.deletedCount;
+ }
+
+ return {
+ updateAssistantDoc,
+ deleteAssistant,
+ deleteAssistants,
+ getAssistants,
+ getAssistant,
+ };
+}
+
+export type AssistantMethods = ReturnType<typeof createAssistantMethods>;
diff --git a/packages/data-schemas/src/methods/banner.ts b/packages/data-schemas/src/methods/banner.ts
new file mode 100644
index 0000000000..6ae4877207
--- /dev/null
+++ b/packages/data-schemas/src/methods/banner.ts
@@ -0,0 +1,33 @@
+import type { Model } from 'mongoose';
+import logger from '~/config/winston';
+import type { IBanner, IUser } from '~/types';
+
+export function createBannerMethods(mongoose: typeof import('mongoose')) {
+ /**
+ * Retrieves the current active banner.
+ */
+ async function getBanner(user?: IUser | null): Promise<IBanner | null> {
+ try {
+ const Banner = mongoose.models.Banner as Model<IBanner>;
+ const now = new Date();
+ const banner = (await Banner.findOne({
+ displayFrom: { $lte: now },
+ $or: [{ displayTo: { $gte: now } }, { displayTo: null }],
+ type: 'banner',
+ }).lean()) as IBanner | null;
+
+ if (!banner || banner.isPublic || user != null) {
+ return banner;
+ }
+
+ return null;
+ } catch (error) {
+ logger.error('[getBanners] Error getting banners', error);
+ throw new Error('Error getting banners');
+ }
+ }
+
+ return { getBanner };
+}
+
+export type BannerMethods = ReturnType<typeof createBannerMethods>;
diff --git a/packages/data-schemas/src/methods/categories.ts b/packages/data-schemas/src/methods/categories.ts
new file mode 100644
index 0000000000..4761a32c16
--- /dev/null
+++ b/packages/data-schemas/src/methods/categories.ts
@@ -0,0 +1,33 @@
+import logger from '~/config/winston';
+
+const options = [
+ { label: 'com_ui_idea', value: 'idea' },
+ { label: 'com_ui_travel', value: 'travel' },
+ { label: 'com_ui_teach_or_explain', value: 'teach_or_explain' },
+ { label: 'com_ui_write', value: 'write' },
+ { label: 'com_ui_shop', value: 'shop' },
+ { label: 'com_ui_code', value: 'code' },
+ { label: 'com_ui_misc', value: 'misc' },
+ { label: 'com_ui_roleplay', value: 'roleplay' },
+ { label: 'com_ui_finance', value: 'finance' },
+] as const;
+
+export type CategoryOption = { label: string; value: string };
+
+export function createCategoriesMethods(_mongoose: typeof import('mongoose')) {
+ /**
+ * Retrieves the categories.
+ */
+ async function getCategories(): Promise<CategoryOption[]> {
+ try {
+ return [...options];
+ } catch (error) {
+ logger.error('Error getting categories', error);
+ return [];
+ }
+ }
+
+ return { getCategories };
+}
+
+export type CategoriesMethods = ReturnType<typeof createCategoriesMethods>;
diff --git a/api/models/Conversation.spec.js b/packages/data-schemas/src/methods/conversation.spec.ts
similarity index 67%
rename from api/models/Conversation.spec.js
rename to packages/data-schemas/src/methods/conversation.spec.ts
index e9e4b5762d..ae19efaf68 100644
--- a/api/models/Conversation.spec.js
+++ b/packages/data-schemas/src/methods/conversation.spec.ts
@@ -1,39 +1,89 @@
-const mongoose = require('mongoose');
-const { v4: uuidv4 } = require('uuid');
-const { EModelEndpoint } = require('librechat-data-provider');
-const { MongoMemoryServer } = require('mongodb-memory-server');
-const {
- deleteNullOrEmptyConversations,
- searchConversation,
- getConvosByCursor,
- getConvosQueried,
- getConvoFiles,
- getConvoTitle,
- deleteConvos,
- saveConvo,
- getConvo,
-} = require('./Conversation');
-jest.mock('~/server/services/Config/app');
-jest.mock('./Message');
-const { getMessages, deleteMessages } = require('./Message');
-
-const { Conversation } = require('~/db/models');
+import mongoose from 'mongoose';
+import { v4 as uuidv4 } from 'uuid';
+import { EModelEndpoint } from 'librechat-data-provider';
+import type { IConversation } from '../types';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import { ConversationMethods, createConversationMethods } from './conversation';
+import { createModels } from '../models';
+
+jest.mock('~/config/winston', () => ({
+ error: jest.fn(),
+ warn: jest.fn(),
+ info: jest.fn(),
+ debug: jest.fn(),
+}));
+
+let mongoServer: InstanceType<typeof MongoMemoryServer>;
+let Conversation: mongoose.Model<IConversation>;
+let modelsToCleanup: string[] = [];
+
+// Mock message methods (same as original test mocking ./Message)
+const getMessages = jest.fn().mockResolvedValue([]);
+const deleteMessages = jest.fn().mockResolvedValue({ deletedCount: 0 });
+
+let methods: ConversationMethods;
+
+beforeAll(async () => {
+ mongoServer = await MongoMemoryServer.create();
+ const mongoUri = mongoServer.getUri();
+
+ const models = createModels(mongoose);
+ modelsToCleanup = Object.keys(models);
+ Object.assign(mongoose.models, models);
+ Conversation = mongoose.models.Conversation as mongoose.Model<IConversation>;
+
+ methods = createConversationMethods(mongoose, { getMessages, deleteMessages });
+
+ await mongoose.connect(mongoUri);
+});
-describe('Conversation Operations', () => {
- let mongoServer;
- let mockReq;
- let mockConversationData;
-
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- await mongoose.connect(mongoUri);
- });
+afterAll(async () => {
+ const collections = mongoose.connection.collections;
+ for (const key in collections) {
+ await collections[key].deleteMany({});
+ }
- afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- });
+ for (const modelName of modelsToCleanup) {
+ if (mongoose.models[modelName]) {
+ delete mongoose.models[modelName];
+ }
+ }
+
+ await mongoose.disconnect();
+ await mongoServer.stop();
+});
+
+const saveConvo = (...args: Parameters<ConversationMethods['saveConvo']>) =>
+ methods.saveConvo(...args) as Promise<IConversation | null>;
+const getConvo = (...args: Parameters<ConversationMethods['getConvo']>) =>
+ methods.getConvo(...args);
+const getConvoTitle = (...args: Parameters<ConversationMethods['getConvoTitle']>) =>
+ methods.getConvoTitle(...args);
+const getConvoFiles = (...args: Parameters<ConversationMethods['getConvoFiles']>) =>
+ methods.getConvoFiles(...args);
+const deleteConvos = (...args: Parameters<ConversationMethods['deleteConvos']>) =>
+ methods.deleteConvos(...args);
+const getConvosByCursor = (...args: Parameters<ConversationMethods['getConvosByCursor']>) =>
+ methods.getConvosByCursor(...args);
+const getConvosQueried = (...args: Parameters<ConversationMethods['getConvosQueried']>) =>
+ methods.getConvosQueried(...args);
+const deleteNullOrEmptyConversations = (
+ ...args: Parameters<ConversationMethods['deleteNullOrEmptyConversations']>
+) => methods.deleteNullOrEmptyConversations(...args);
+const searchConversation = (...args: Parameters<ConversationMethods['searchConversation']>) =>
+ methods.searchConversation(...args);
+
+describe('Conversation Operations', () => {
+ let mockCtx: {
+ userId: string;
+ isTemporary?: boolean;
+ interfaceConfig?: { temporaryChatRetention?: number };
+ };
+ let mockConversationData: {
+ conversationId: string;
+ title: string;
+ endpoint: string;
+ };
beforeEach(async () => {
// Clear database
@@ -41,18 +91,13 @@ describe('Conversation Operations', () => {
// Reset mocks
jest.clearAllMocks();
-
- // Default mock implementations
getMessages.mockResolvedValue([]);
deleteMessages.mockResolvedValue({ deletedCount: 0 });
- mockReq = {
- user: { id: 'user123' },
- body: {},
- config: {
- interfaceConfig: {
- temporaryChatRetention: 24, // Default 24 hours
- },
+ mockCtx = {
+ userId: 'user123',
+ interfaceConfig: {
+ temporaryChatRetention: 24, // Default 24 hours
},
};
@@ -65,29 +110,28 @@ describe('Conversation Operations', () => {
describe('saveConvo', () => {
it('should save a conversation for an authenticated user', async () => {
- const result = await saveConvo(mockReq, mockConversationData);
+ const result = await saveConvo(mockCtx, mockConversationData);
- expect(result.conversationId).toBe(mockConversationData.conversationId);
- expect(result.user).toBe('user123');
- expect(result.title).toBe('Test Conversation');
- expect(result.endpoint).toBe(EModelEndpoint.openAI);
+ expect(result?.conversationId).toBe(mockConversationData.conversationId);
+ expect(result?.user).toBe('user123');
+ expect(result?.title).toBe('Test Conversation');
+ expect(result?.endpoint).toBe(EModelEndpoint.openAI);
// Verify the conversation was actually saved to the database
- const savedConvo = await Conversation.findOne({
+ const savedConvo = await Conversation.findOne<IConversation>({
conversationId: mockConversationData.conversationId,
user: 'user123',
});
expect(savedConvo).toBeTruthy();
- expect(savedConvo.title).toBe('Test Conversation');
+ expect(savedConvo?.title).toBe('Test Conversation');
});
it('should query messages when saving a conversation', async () => {
// Mock messages as ObjectIds
- const mongoose = require('mongoose');
const mockMessages = [new mongoose.Types.ObjectId(), new mongoose.Types.ObjectId()];
getMessages.mockResolvedValue(mockMessages);
- await saveConvo(mockReq, mockConversationData);
+ await saveConvo(mockCtx, mockConversationData);
// Verify that getMessages was called with correct parameters
expect(getMessages).toHaveBeenCalledWith(
@@ -98,18 +142,18 @@ describe('Conversation Operations', () => {
it('should handle newConversationId when provided', async () => {
const newConversationId = uuidv4();
- const result = await saveConvo(mockReq, {
+ const result = await saveConvo(mockCtx, {
...mockConversationData,
newConversationId,
});
- expect(result.conversationId).toBe(newConversationId);
+ expect(result?.conversationId).toBe(newConversationId);
});
it('should not create a conversation when noUpsert is true and conversation does not exist', async () => {
const nonExistentId = uuidv4();
const result = await saveConvo(
- mockReq,
+ mockCtx,
{ conversationId: nonExistentId, title: 'Ghost Title' },
{ noUpsert: true },
);
@@ -121,30 +165,30 @@ describe('Conversation Operations', () => {
});
it('should update an existing conversation when noUpsert is true', async () => {
- await saveConvo(mockReq, mockConversationData);
+ await saveConvo(mockCtx, mockConversationData);
const result = await saveConvo(
- mockReq,
+ mockCtx,
{ conversationId: mockConversationData.conversationId, title: 'Updated Title' },
{ noUpsert: true },
);
expect(result).not.toBeNull();
- expect(result.title).toBe('Updated Title');
- expect(result.conversationId).toBe(mockConversationData.conversationId);
+ expect(result?.title).toBe('Updated Title');
+ expect(result?.conversationId).toBe(mockConversationData.conversationId);
});
it('should still upsert by default when noUpsert is not provided', async () => {
const newId = uuidv4();
- const result = await saveConvo(mockReq, {
+ const result = await saveConvo(mockCtx, {
conversationId: newId,
title: 'New Conversation',
endpoint: EModelEndpoint.openAI,
});
expect(result).not.toBeNull();
- expect(result.conversationId).toBe(newId);
- expect(result.title).toBe('New Conversation');
+ expect(result?.conversationId).toBe(newId);
+ expect(result?.title).toBe('New Conversation');
});
it('should handle unsetFields metadata', async () => {
@@ -152,31 +196,30 @@ describe('Conversation Operations', () => {
unsetFields: { someField: 1 },
};
- await saveConvo(mockReq, mockConversationData, metadata);
+ await saveConvo(mockCtx, mockConversationData, metadata);
- const savedConvo = await Conversation.findOne({
+ const savedConvo = await Conversation.findOne<IConversation & { someField?: string }>({
conversationId: mockConversationData.conversationId,
});
- expect(savedConvo.someField).toBeUndefined();
+ expect(savedConvo?.someField).toBeUndefined();
});
});
describe('isTemporary conversation handling', () => {
it('should save a conversation with expiredAt when isTemporary is true', async () => {
- mockReq.config.interfaceConfig.temporaryChatRetention = 24;
-
- mockReq.body = { isTemporary: true };
+ mockCtx.interfaceConfig = { temporaryChatRetention: 24 };
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveConvo(mockReq, mockConversationData);
+ const result = await saveConvo(mockCtx, mockConversationData);
const afterSave = new Date();
- expect(result.conversationId).toBe(mockConversationData.conversationId);
- expect(result.expiredAt).toBeDefined();
- expect(result.expiredAt).toBeInstanceOf(Date);
+ expect(result?.conversationId).toBe(mockConversationData.conversationId);
+ expect(result?.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeInstanceOf(Date);
const expectedExpirationTime = new Date(beforeSave.getTime() + 24 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -187,36 +230,35 @@ describe('Conversation Operations', () => {
});
it('should save a conversation without expiredAt when isTemporary is false', async () => {
- mockReq.body = { isTemporary: false };
+ mockCtx.isTemporary = false;
- const result = await saveConvo(mockReq, mockConversationData);
+ const result = await saveConvo(mockCtx, mockConversationData);
- expect(result.conversationId).toBe(mockConversationData.conversationId);
- expect(result.expiredAt).toBeNull();
+ expect(result?.conversationId).toBe(mockConversationData.conversationId);
+ expect(result?.expiredAt).toBeNull();
});
it('should save a conversation without expiredAt when isTemporary is not provided', async () => {
- mockReq.body = {};
+ mockCtx.isTemporary = undefined;
- const result = await saveConvo(mockReq, mockConversationData);
+ const result = await saveConvo(mockCtx, mockConversationData);
- expect(result.conversationId).toBe(mockConversationData.conversationId);
- expect(result.expiredAt).toBeNull();
+ expect(result?.conversationId).toBe(mockConversationData.conversationId);
+ expect(result?.expiredAt).toBeNull();
});
it('should use custom retention period from config', async () => {
- mockReq.config.interfaceConfig.temporaryChatRetention = 48;
-
- mockReq.body = { isTemporary: true };
+ mockCtx.interfaceConfig = { temporaryChatRetention: 48 };
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveConvo(mockReq, mockConversationData);
+ const result = await saveConvo(mockCtx, mockConversationData);
- expect(result.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeDefined();
// Verify expiredAt is approximately 48 hours in the future
const expectedExpirationTime = new Date(beforeSave.getTime() + 48 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -228,18 +270,17 @@ describe('Conversation Operations', () => {
it('should handle minimum retention period (1 hour)', async () => {
// Mock app config with less than minimum retention
- mockReq.config.interfaceConfig.temporaryChatRetention = 0.5; // Half hour - should be clamped to 1 hour
-
- mockReq.body = { isTemporary: true };
+ mockCtx.interfaceConfig = { temporaryChatRetention: 0.5 }; // Half hour - should be clamped to 1 hour
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveConvo(mockReq, mockConversationData);
+ const result = await saveConvo(mockCtx, mockConversationData);
- expect(result.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeDefined();
// Verify expiredAt is approximately 1 hour in the future (minimum)
const expectedExpirationTime = new Date(beforeSave.getTime() + 1 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -251,18 +292,17 @@ describe('Conversation Operations', () => {
it('should handle maximum retention period (8760 hours)', async () => {
// Mock app config with more than maximum retention
- mockReq.config.interfaceConfig.temporaryChatRetention = 10000; // Should be clamped to 8760 hours
-
- mockReq.body = { isTemporary: true };
+ mockCtx.interfaceConfig = { temporaryChatRetention: 10000 }; // Should be clamped to 8760 hours
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveConvo(mockReq, mockConversationData);
+ const result = await saveConvo(mockCtx, mockConversationData);
- expect(result.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeDefined();
// Verify expiredAt is approximately 8760 hours (1 year) in the future
const expectedExpirationTime = new Date(beforeSave.getTime() + 8760 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -274,22 +314,21 @@ describe('Conversation Operations', () => {
it('should handle missing config gracefully', async () => {
// Simulate missing config - should use default retention period
- delete mockReq.config;
-
- mockReq.body = { isTemporary: true };
+ mockCtx.interfaceConfig = undefined;
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveConvo(mockReq, mockConversationData);
+ const result = await saveConvo(mockCtx, mockConversationData);
const afterSave = new Date();
// Should still save the conversation with default retention period (30 days)
- expect(result.conversationId).toBe(mockConversationData.conversationId);
- expect(result.expiredAt).toBeDefined();
- expect(result.expiredAt).toBeInstanceOf(Date);
+ expect(result?.conversationId).toBe(mockConversationData.conversationId);
+ expect(result?.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeInstanceOf(Date);
// Verify expiredAt is approximately 30 days in the future (720 hours)
const expectedExpirationTime = new Date(beforeSave.getTime() + 720 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -301,18 +340,17 @@ describe('Conversation Operations', () => {
it('should use default retention when config is not provided', async () => {
// Mock getAppConfig to return empty config
- mockReq.config = {}; // Empty config
-
- mockReq.body = { isTemporary: true };
+ mockCtx.interfaceConfig = undefined; // Empty config
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveConvo(mockReq, mockConversationData);
+ const result = await saveConvo(mockCtx, mockConversationData);
- expect(result.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeDefined();
// Default retention is 30 days (720 hours)
const expectedExpirationTime = new Date(beforeSave.getTime() + 30 * 24 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -324,40 +362,39 @@ describe('Conversation Operations', () => {
it('should update expiredAt when saving existing temporary conversation', async () => {
// First save a temporary conversation
- mockReq.config.interfaceConfig.temporaryChatRetention = 24;
-
- mockReq.body = { isTemporary: true };
- const firstSave = await saveConvo(mockReq, mockConversationData);
- const originalExpiredAt = firstSave.expiredAt;
+ mockCtx.interfaceConfig = { temporaryChatRetention: 24 };
+ mockCtx.isTemporary = true;
+ const firstSave = await saveConvo(mockCtx, mockConversationData);
+ const originalExpiredAt = firstSave?.expiredAt ?? new Date(0);
// Wait a bit to ensure time difference
await new Promise((resolve) => setTimeout(resolve, 100));
// Save again with same conversationId but different title
const updatedData = { ...mockConversationData, title: 'Updated Title' };
- const secondSave = await saveConvo(mockReq, updatedData);
+ const secondSave = await saveConvo(mockCtx, updatedData);
// Should update title and create new expiredAt
- expect(secondSave.title).toBe('Updated Title');
- expect(secondSave.expiredAt).toBeDefined();
- expect(new Date(secondSave.expiredAt).getTime()).toBeGreaterThan(
+ expect(secondSave?.title).toBe('Updated Title');
+ expect(secondSave?.expiredAt).toBeDefined();
+ expect(new Date(secondSave?.expiredAt ?? 0).getTime()).toBeGreaterThan(
new Date(originalExpiredAt).getTime(),
);
});
it('should not set expiredAt when updating non-temporary conversation', async () => {
// First save a non-temporary conversation
- mockReq.body = { isTemporary: false };
- const firstSave = await saveConvo(mockReq, mockConversationData);
- expect(firstSave.expiredAt).toBeNull();
+ mockCtx.isTemporary = false;
+ const firstSave = await saveConvo(mockCtx, mockConversationData);
+ expect(firstSave?.expiredAt).toBeNull();
// Update without isTemporary flag
- mockReq.body = {};
+ mockCtx.isTemporary = undefined;
const updatedData = { ...mockConversationData, title: 'Updated Title' };
- const secondSave = await saveConvo(mockReq, updatedData);
+ const secondSave = await saveConvo(mockCtx, updatedData);
- expect(secondSave.title).toBe('Updated Title');
- expect(secondSave.expiredAt).toBeNull();
+ expect(secondSave?.title).toBe('Updated Title');
+ expect(secondSave?.expiredAt).toBeNull();
});
it('should filter out expired conversations in getConvosByCursor', async () => {
@@ -381,13 +418,13 @@ describe('Conversation Operations', () => {
});
// Mock Meili search
- Conversation.meiliSearch = jest.fn().mockResolvedValue({ hits: [] });
+ Object.assign(Conversation, { meiliSearch: jest.fn().mockResolvedValue({ hits: [] }) });
const result = await getConvosByCursor('user123');
// Should only return conversations with null or non-existent expiredAt
- expect(result.conversations).toHaveLength(1);
- expect(result.conversations[0].conversationId).toBe(nonExpiredConvo.conversationId);
+ expect(result?.conversations).toHaveLength(1);
+ expect(result?.conversations[0]?.conversationId).toBe(nonExpiredConvo.conversationId);
});
it('should filter out expired conversations in getConvosQueried', async () => {
@@ -416,10 +453,10 @@ describe('Conversation Operations', () => {
const result = await getConvosQueried('user123', convoIds);
// Should only return the non-expired conversation
- expect(result.conversations).toHaveLength(1);
- expect(result.conversations[0].conversationId).toBe(nonExpiredConvo.conversationId);
- expect(result.convoMap[nonExpiredConvo.conversationId]).toBeDefined();
- expect(result.convoMap[expiredConvo.conversationId]).toBeUndefined();
+ expect(result?.conversations).toHaveLength(1);
+ expect(result?.conversations[0].conversationId).toBe(nonExpiredConvo.conversationId);
+ expect(result?.convoMap[nonExpiredConvo.conversationId]).toBeDefined();
+ expect(result?.convoMap[expiredConvo.conversationId]).toBeUndefined();
});
});
@@ -435,9 +472,9 @@ describe('Conversation Operations', () => {
const result = await searchConversation(mockConversationData.conversationId);
expect(result).toBeTruthy();
- expect(result.conversationId).toBe(mockConversationData.conversationId);
- expect(result.user).toBe('user123');
- expect(result.title).toBeUndefined(); // Only returns conversationId and user
+ expect(result!.conversationId).toBe(mockConversationData.conversationId);
+ expect(result!.user).toBe('user123');
+ expect((result as unknown as { title?: string }).title).toBeUndefined(); // Only returns conversationId and user
});
it('should return null if conversation not found', async () => {
@@ -457,9 +494,9 @@ describe('Conversation Operations', () => {
const result = await getConvo('user123', mockConversationData.conversationId);
- expect(result.conversationId).toBe(mockConversationData.conversationId);
- expect(result.user).toBe('user123');
- expect(result.title).toBe('Test Conversation');
+ expect(result!.conversationId).toBe(mockConversationData.conversationId);
+ expect(result!.user).toBe('user123');
+ expect(result!.title).toBe('Test Conversation');
});
it('should return null if conversation not found', async () => {
@@ -545,8 +582,8 @@ describe('Conversation Operations', () => {
conversationId: mockConversationData.conversationId,
});
- expect(result.deletedCount).toBe(1);
- expect(result.messages.deletedCount).toBe(5);
+ expect(result?.deletedCount).toBe(1);
+ expect(result?.messages.deletedCount).toBe(5);
expect(deleteMessages).toHaveBeenCalledWith({
conversationId: { $in: [mockConversationData.conversationId] },
user: 'user123',
@@ -582,8 +619,8 @@ describe('Conversation Operations', () => {
const result = await deleteNullOrEmptyConversations();
- expect(result.conversations.deletedCount).toBe(0); // No invalid conversations to delete
- expect(result.messages.deletedCount).toBe(0);
+ expect(result?.conversations.deletedCount).toBe(0); // No invalid conversations to delete
+ expect(result?.messages.deletedCount).toBe(0);
// Verify valid conversation remains
const remainingConvos = await Conversation.find({});
@@ -597,7 +634,7 @@ describe('Conversation Operations', () => {
// Force a database error by disconnecting
await mongoose.disconnect();
- const result = await saveConvo(mockReq, mockConversationData);
+ const result = await saveConvo(mockCtx, mockConversationData);
expect(result).toEqual({ message: 'Error saving conversation' });
@@ -611,7 +648,7 @@ describe('Conversation Operations', () => {
* Helper to create conversations with specific timestamps
* Uses collection.insertOne to bypass Mongoose timestamps entirely
*/
- const createConvoWithTimestamps = async (index, createdAt, updatedAt) => {
+ const createConvoWithTimestamps = async (index: number, createdAt: Date, updatedAt: Date) => {
const conversationId = uuidv4();
// Use collection-level insert to bypass Mongoose timestamps
await Conversation.collection.insertOne({
@@ -630,7 +667,7 @@ describe('Conversation Operations', () => {
it('should not skip conversations at page boundaries', async () => {
// Create 30 conversations to ensure pagination (limit is 25)
const baseTime = new Date('2026-01-01T00:00:00.000Z');
- const convos = [];
+ const convos: unknown[] = [];
for (let i = 0; i < 30; i++) {
const updatedAt = new Date(baseTime.getTime() - i * 60000); // Each 1 minute apart
@@ -656,8 +693,8 @@ describe('Conversation Operations', () => {
// Verify no duplicates and no gaps
const allIds = [
- ...page1.conversations.map((c) => c.conversationId),
- ...page2.conversations.map((c) => c.conversationId),
+ ...page1.conversations.map((c: IConversation) => c.conversationId),
+ ...page2.conversations.map((c: IConversation) => c.conversationId),
];
const uniqueIds = new Set(allIds);
@@ -672,7 +709,7 @@ describe('Conversation Operations', () => {
const baseTime = new Date('2026-01-01T12:00:00.000Z');
// Create exactly 26 conversations
- const convos = [];
+ const convos: (IConversation | null)[] = [];
for (let i = 0; i < 26; i++) {
const updatedAt = new Date(baseTime.getTime() - i * 60000);
const convo = await createConvoWithTimestamps(i, updatedAt, updatedAt);
@@ -689,8 +726,8 @@ describe('Conversation Operations', () => {
expect(page1.nextCursor).toBeTruthy();
// Item 26 should NOT be in page 1
- const page1Ids = page1.conversations.map((c) => c.conversationId);
- expect(page1Ids).not.toContain(item26.conversationId);
+ const page1Ids = page1.conversations.map((c: IConversation) => c.conversationId);
+ expect(page1Ids).not.toContain(item26!.conversationId);
// Fetch second page
const page2 = await getConvosByCursor('user123', {
@@ -700,7 +737,7 @@ describe('Conversation Operations', () => {
// Item 26 MUST be in page 2 (this was the bug - it was being skipped)
expect(page2.conversations).toHaveLength(1);
- expect(page2.conversations[0].conversationId).toBe(item26.conversationId);
+ expect(page2.conversations[0].conversationId).toBe(item26!.conversationId);
});
it('should sort by updatedAt DESC by default', async () => {
@@ -727,10 +764,10 @@ describe('Conversation Operations', () => {
const result = await getConvosByCursor('user123');
// Should be sorted by updatedAt DESC (most recent first)
- expect(result.conversations).toHaveLength(3);
- expect(result.conversations[0].conversationId).toBe(convo1.conversationId); // Jan 3 updatedAt
- expect(result.conversations[1].conversationId).toBe(convo2.conversationId); // Jan 2 updatedAt
- expect(result.conversations[2].conversationId).toBe(convo3.conversationId); // Jan 1 updatedAt
+ expect(result?.conversations).toHaveLength(3);
+ expect(result?.conversations[0].conversationId).toBe(convo1!.conversationId); // Jan 3 updatedAt
+ expect(result?.conversations[1].conversationId).toBe(convo2!.conversationId); // Jan 2 updatedAt
+ expect(result?.conversations[2].conversationId).toBe(convo3!.conversationId); // Jan 1 updatedAt
});
it('should handle conversations with same updatedAt (tie-breaker)', async () => {
@@ -744,12 +781,12 @@ describe('Conversation Operations', () => {
const result = await getConvosByCursor('user123');
// All 3 should be returned (no skipping due to same timestamps)
- expect(result.conversations).toHaveLength(3);
+ expect(result?.conversations).toHaveLength(3);
- const returnedIds = result.conversations.map((c) => c.conversationId);
- expect(returnedIds).toContain(convo1.conversationId);
- expect(returnedIds).toContain(convo2.conversationId);
- expect(returnedIds).toContain(convo3.conversationId);
+ const returnedIds = result?.conversations.map((c: IConversation) => c.conversationId);
+ expect(returnedIds).toContain(convo1!.conversationId);
+ expect(returnedIds).toContain(convo2!.conversationId);
+ expect(returnedIds).toContain(convo3!.conversationId);
});
it('should handle cursor pagination with conversations updated during pagination', async () => {
@@ -806,13 +843,15 @@ describe('Conversation Operations', () => {
const page1 = await getConvosByCursor('user123', { limit: 25 });
// Decode the cursor to verify it's based on the last RETURNED item
- const decodedCursor = JSON.parse(Buffer.from(page1.nextCursor, 'base64').toString());
+ const decodedCursor = JSON.parse(
+ Buffer.from(page1.nextCursor as string, 'base64').toString(),
+ );
// The cursor should match the last item in page1 (item at index 24)
- const lastReturnedItem = page1.conversations[24];
+ const lastReturnedItem = page1.conversations[24] as IConversation;
expect(new Date(decodedCursor.primary).getTime()).toBe(
- new Date(lastReturnedItem.updatedAt).getTime(),
+ new Date(lastReturnedItem.updatedAt ?? 0).getTime(),
);
});
@@ -831,26 +870,26 @@ describe('Conversation Operations', () => {
);
// Verify timestamps were set correctly
- expect(new Date(convo1.createdAt).getTime()).toBe(
+ expect(new Date(convo1!.createdAt ?? 0).getTime()).toBe(
new Date('2026-01-03T00:00:00.000Z').getTime(),
);
- expect(new Date(convo2.createdAt).getTime()).toBe(
+ expect(new Date(convo2!.createdAt ?? 0).getTime()).toBe(
new Date('2026-01-01T00:00:00.000Z').getTime(),
);
const result = await getConvosByCursor('user123', { sortBy: 'createdAt' });
// Should be sorted by createdAt DESC
- expect(result.conversations).toHaveLength(2);
- expect(result.conversations[0].conversationId).toBe(convo1.conversationId); // Jan 3 createdAt
- expect(result.conversations[1].conversationId).toBe(convo2.conversationId); // Jan 1 createdAt
+ expect(result?.conversations).toHaveLength(2);
+ expect(result?.conversations[0].conversationId).toBe(convo1!.conversationId); // Jan 3 createdAt
+ expect(result?.conversations[1].conversationId).toBe(convo2!.conversationId); // Jan 1 createdAt
});
it('should handle empty result set gracefully', async () => {
const result = await getConvosByCursor('user123');
- expect(result.conversations).toHaveLength(0);
- expect(result.nextCursor).toBeNull();
+ expect(result?.conversations).toHaveLength(0);
+ expect(result?.nextCursor).toBeNull();
});
it('should handle exactly limit number of conversations (no next page)', async () => {
@@ -864,8 +903,8 @@ describe('Conversation Operations', () => {
const result = await getConvosByCursor('user123', { limit: 25 });
- expect(result.conversations).toHaveLength(25);
- expect(result.nextCursor).toBeNull(); // No next page
+ expect(result?.conversations).toHaveLength(25);
+ expect(result?.nextCursor).toBeNull(); // No next page
});
});
});
diff --git a/packages/data-schemas/src/methods/conversation.ts b/packages/data-schemas/src/methods/conversation.ts
new file mode 100644
index 0000000000..7a62afef9e
--- /dev/null
+++ b/packages/data-schemas/src/methods/conversation.ts
@@ -0,0 +1,488 @@
+import type { FilterQuery, Model, SortOrder } from 'mongoose';
+import logger from '~/config/winston';
+import { createTempChatExpirationDate } from '~/utils/tempChatRetention';
+import type { AppConfig, IConversation } from '~/types';
+import type { MessageMethods } from './message';
+import type { DeleteResult } from 'mongoose';
+
+export interface ConversationMethods {
+ getConvoFiles(conversationId: string): Promise<string[]>;
+ searchConversation(conversationId: string): Promise<IConversation | null>;
+ deleteNullOrEmptyConversations(): Promise<{
+ conversations: { deletedCount?: number };
+ messages: { deletedCount?: number };
+ }>;
+ saveConvo(
+ ctx: { userId: string; isTemporary?: boolean; interfaceConfig?: AppConfig['interfaceConfig'] },
+ data: { conversationId: string; newConversationId?: string; [key: string]: unknown },
+ metadata?: { context?: string; unsetFields?: Record<string, number>; noUpsert?: boolean },
+ ): Promise<IConversation | { message: string } | null>;
+ bulkSaveConvos(conversations: Array<Record<string, unknown>>): Promise<unknown>;
+ getConvosByCursor(
+ user: string,
+ options?: {
+ cursor?: string | null;
+ limit?: number;
+ isArchived?: boolean;
+ tags?: string[];
+ search?: string;
+ sortBy?: string;
+ sortDirection?: string;
+ },
+ ): Promise<{ conversations: IConversation[]; nextCursor: string | null }>;
+ getConvosQueried(
+ user: string,
+ convoIds: Array<{ conversationId: string }> | null,
+ cursor?: string | null,
+ limit?: number,
+ ): Promise<{
+ conversations: IConversation[];
+ nextCursor: string | null;
+ convoMap: Record<string, unknown>;
+ }>;
+ getConvo(user: string, conversationId: string): Promise<IConversation | null>;
+ getConvoTitle(user: string, conversationId: string): Promise<string | null>;
+ deleteConvos(
+ user: string,
+ filter: FilterQuery<IConversation>,
+ ): Promise<DeleteResult & { messages: DeleteResult }>;
+}
+
+export function createConversationMethods(
+ mongoose: typeof import('mongoose'),
+ messageMethods?: Pick<MessageMethods, 'getMessages' | 'deleteMessages'>,
+): ConversationMethods {
+ function getMessageMethods() {
+ if (!messageMethods) {
+ throw new Error('Message methods not injected into conversation methods');
+ }
+ return messageMethods;
+ }
+
+ /**
+ * Searches for a conversation by conversationId and returns a lean document with only conversationId and user.
+ */
+ async function searchConversation(conversationId: string) {
+ try {
+ const Conversation = mongoose.models.Conversation as Model<IConversation>;
+ return await Conversation.findOne({ conversationId }, 'conversationId user').lean();
+ } catch (error) {
+ logger.error('[searchConversation] Error searching conversation', error);
+ throw new Error('Error searching conversation');
+ }
+ }
+
+ /**
+ * Retrieves a single conversation for a given user and conversation ID.
+ */
+ async function getConvo(user: string, conversationId: string) {
+ try {
+ const Conversation = mongoose.models.Conversation as Model<IConversation>;
+ return await Conversation.findOne({ user, conversationId }).lean();
+ } catch (error) {
+ logger.error('[getConvo] Error getting single conversation', error);
+ throw new Error('Error getting single conversation');
+ }
+ }
+
+ /**
+ * Deletes conversations and messages with null or empty IDs.
+ */
+ async function deleteNullOrEmptyConversations() {
+ try {
+ const Conversation = mongoose.models.Conversation as Model<IConversation>;
+ const { deleteMessages } = getMessageMethods();
+ const filter = {
+ $or: [
+ { conversationId: null },
+ { conversationId: '' },
+ { conversationId: { $exists: false } },
+ ],
+ };
+
+ const result = await Conversation.deleteMany(filter);
+ const messageDeleteResult = await deleteMessages(filter);
+
+ logger.info(
+ `[deleteNullOrEmptyConversations] Deleted ${result.deletedCount} conversations and ${messageDeleteResult.deletedCount} messages`,
+ );
+
+ return {
+ conversations: result,
+ messages: messageDeleteResult,
+ };
+ } catch (error) {
+ logger.error('[deleteNullOrEmptyConversations] Error deleting conversations', error);
+ throw new Error('Error deleting conversations with null or empty conversationId');
+ }
+ }
+
+ /**
+ * Searches for a conversation by conversationId and returns associated file ids.
+ */
+ async function getConvoFiles(conversationId: string): Promise<string[]> {
+ try {
+ const Conversation = mongoose.models.Conversation as Model<IConversation>;
+ return (
+ ((await Conversation.findOne({ conversationId }, 'files').lean()) as IConversation | null)
+ ?.files ?? []
+ );
+ } catch (error) {
+ logger.error('[getConvoFiles] Error getting conversation files', error);
+ throw new Error('Error getting conversation files');
+ }
+ }
+
+ /**
+ * Saves a conversation to the database.
+ */
+ async function saveConvo(
+ {
+ userId,
+ isTemporary,
+ interfaceConfig,
+ }: {
+ userId: string;
+ isTemporary?: boolean;
+ interfaceConfig?: AppConfig['interfaceConfig'];
+ },
+ {
+ conversationId,
+ newConversationId,
+ ...convo
+ }: {
+ conversationId: string;
+ newConversationId?: string;
+ [key: string]: unknown;
+ },
+ metadata?: { context?: string; unsetFields?: Record<string, number>; noUpsert?: boolean },
+ ) {
+ try {
+ const Conversation = mongoose.models.Conversation as Model<IConversation>;
+ const { getMessages } = getMessageMethods();
+
+ if (metadata?.context) {
+ logger.debug(`[saveConvo] ${metadata.context}`);
+ }
+
+ const messages = await getMessages({ conversationId }, '_id');
+ const update: Record<string, unknown> = { ...convo, messages, user: userId };
+
+ if (newConversationId) {
+ update.conversationId = newConversationId;
+ }
+
+ if (isTemporary) {
+ try {
+ update.expiredAt = createTempChatExpirationDate(interfaceConfig);
+ } catch (err) {
+ logger.error('Error creating temporary chat expiration date:', err);
+ logger.info(`---\`saveConvo\` context: ${metadata?.context}`);
+ update.expiredAt = null;
+ }
+ } else {
+ update.expiredAt = null;
+ }
+
+ const updateOperation: Record<string, unknown> = { $set: update };
+ if (metadata?.unsetFields && Object.keys(metadata.unsetFields).length > 0) {
+ updateOperation.$unset = metadata.unsetFields;
+ }
+
+ const conversation = await Conversation.findOneAndUpdate(
+ { conversationId, user: userId },
+ updateOperation,
+ {
+ new: true,
+ upsert: metadata?.noUpsert !== true,
+ },
+ );
+
+ if (!conversation) {
+ logger.debug('[saveConvo] Conversation not found, skipping update');
+ return null;
+ }
+
+ return conversation.toObject();
+ } catch (error) {
+ logger.error('[saveConvo] Error saving conversation', error);
+ if (metadata?.context) {
+ logger.info(`[saveConvo] ${metadata.context}`);
+ }
+ return { message: 'Error saving conversation' };
+ }
+ }
+
+ /**
+ * Saves multiple conversations in bulk.
+ */
+ async function bulkSaveConvos(conversations: Array<Record<string, unknown>>) {
+ try {
+ const Conversation = mongoose.models.Conversation as Model<IConversation>;
+ const bulkOps = conversations.map((convo) => ({
+ updateOne: {
+ filter: { conversationId: convo.conversationId, user: convo.user },
+ update: convo,
+ upsert: true,
+ timestamps: false,
+ },
+ }));
+
+ const result = await Conversation.bulkWrite(bulkOps);
+ return result;
+ } catch (error) {
+ logger.error('[bulkSaveConvos] Error saving conversations in bulk', error);
+ throw new Error('Failed to save conversations in bulk.');
+ }
+ }
+
+ /**
+ * Retrieves conversations using cursor-based pagination.
+ */
+ async function getConvosByCursor(
+ user: string,
+ {
+ cursor,
+ limit = 25,
+ isArchived = false,
+ tags,
+ search,
+ sortBy = 'updatedAt',
+ sortDirection = 'desc',
+ }: {
+ cursor?: string | null;
+ limit?: number;
+ isArchived?: boolean;
+ tags?: string[];
+ search?: string;
+ sortBy?: string;
+ sortDirection?: string;
+ } = {},
+ ) {
+ const Conversation = mongoose.models.Conversation as Model<IConversation>;
+ const filters: FilterQuery<IConversation>[] = [{ user } as FilterQuery<IConversation>];
+ if (isArchived) {
+ filters.push({ isArchived: true } as FilterQuery<IConversation>);
+ } else {
+ filters.push({
+ $or: [{ isArchived: false }, { isArchived: { $exists: false } }],
+ } as FilterQuery<IConversation>);
+ }
+
+ if (Array.isArray(tags) && tags.length > 0) {
+ filters.push({ tags: { $in: tags } } as FilterQuery<IConversation>);
+ }
+
+ filters.push({
+ $or: [{ expiredAt: null }, { expiredAt: { $exists: false } }],
+ } as FilterQuery<IConversation>);
+
+ if (search) {
+ try {
+ const meiliResults = await (
+ Conversation as unknown as {
+ meiliSearch: (
+ query: string,
+ options: Record<string, string>,
+ ) => Promise<{
+ hits: Array<{ conversationId: string }>;
+ }>;
+ }
+ ).meiliSearch(search, { filter: `user = "${user}"` });
+ const matchingIds = Array.isArray(meiliResults.hits)
+ ? meiliResults.hits.map((result) => result.conversationId)
+ : [];
+ if (!matchingIds.length) {
+ return { conversations: [], nextCursor: null };
+ }
+ filters.push({ conversationId: { $in: matchingIds } } as FilterQuery<IConversation>);
+ } catch (error) {
+ logger.error('[getConvosByCursor] Error during meiliSearch', error);
+ throw new Error('Error during meiliSearch');
+ }
+ }
+
+ const validSortFields = ['title', 'createdAt', 'updatedAt'];
+ if (!validSortFields.includes(sortBy)) {
+ throw new Error(
+ `Invalid sortBy field: ${sortBy}. Must be one of ${validSortFields.join(', ')}`,
+ );
+ }
+ const finalSortBy = sortBy;
+ const finalSortDirection = sortDirection === 'asc' ? 'asc' : 'desc';
+
+ let cursorFilter: FilterQuery<IConversation> | null = null;
+ if (cursor) {
+ try {
+ const decoded = JSON.parse(Buffer.from(cursor, 'base64').toString());
+ const { primary, secondary } = decoded;
+ const primaryValue = finalSortBy === 'title' ? primary : new Date(primary);
+ const secondaryValue = new Date(secondary);
+ const op = finalSortDirection === 'asc' ? '$gt' : '$lt';
+
+ cursorFilter = {
+ $or: [
+ { [finalSortBy]: { [op]: primaryValue } },
+ {
+ [finalSortBy]: primaryValue,
+ updatedAt: { [op]: secondaryValue },
+ },
+ ],
+ } as FilterQuery<IConversation>;
+ } catch {
+ logger.warn('[getConvosByCursor] Invalid cursor format, starting from beginning');
+ }
+ if (cursorFilter) {
+ filters.push(cursorFilter);
+ }
+ }
+
+ const query: FilterQuery<IConversation> =
+ filters.length === 1 ? filters[0] : ({ $and: filters } as FilterQuery<IConversation>);
+
+ try {
+ const sortOrder: SortOrder = finalSortDirection === 'asc' ? 1 : -1;
+ const sortObj: Record<string, SortOrder> = { [finalSortBy]: sortOrder };
+
+ if (finalSortBy !== 'updatedAt') {
+ sortObj.updatedAt = sortOrder;
+ }
+
+ const convos = await Conversation.find(query)
+ .select(
+ 'conversationId endpoint title createdAt updatedAt user model agent_id assistant_id spec iconURL',
+ )
+ .sort(sortObj)
+ .limit(limit + 1)
+ .lean();
+
+ let nextCursor: string | null = null;
+ if (convos.length > limit) {
+ convos.pop();
+ const lastReturned = convos[convos.length - 1] as Record<string, unknown>;
+ const primaryValue = lastReturned[finalSortBy];
+ const primaryStr =
+ finalSortBy === 'title' ? primaryValue : (primaryValue as Date).toISOString();
+ const secondaryStr = (lastReturned.updatedAt as Date).toISOString();
+ const composite = { primary: primaryStr, secondary: secondaryStr };
+ nextCursor = Buffer.from(JSON.stringify(composite)).toString('base64');
+ }
+
+ return { conversations: convos, nextCursor };
+ } catch (error) {
+ logger.error('[getConvosByCursor] Error getting conversations', error);
+ throw new Error('Error getting conversations');
+ }
+ }
+
+ /**
+ * Fetches specific conversations by ID array with pagination.
+ */
+ async function getConvosQueried(
+ user: string,
+ convoIds: Array<{ conversationId: string }> | null,
+ cursor: string | null = null,
+ limit = 25,
+ ) {
+ try {
+ const Conversation = mongoose.models.Conversation as Model<IConversation>;
+ if (!convoIds?.length) {
+ return { conversations: [], nextCursor: null, convoMap: {} };
+ }
+
+ const conversationIds = convoIds.map((convo) => convo.conversationId);
+
+ const results = await Conversation.find({
+ user,
+ conversationId: { $in: conversationIds },
+ $or: [{ expiredAt: { $exists: false } }, { expiredAt: null }],
+ }).lean();
+
+ results.sort(
+ (a, b) => new Date(b.updatedAt ?? 0).getTime() - new Date(a.updatedAt ?? 0).getTime(),
+ );
+
+ let filtered = results;
+ if (cursor && cursor !== 'start') {
+ const cursorDate = new Date(cursor);
+ filtered = results.filter((convo) => new Date(convo.updatedAt ?? 0) < cursorDate);
+ }
+
+ const limited = filtered.slice(0, limit + 1);
+ let nextCursor: string | null = null;
+ if (limited.length > limit) {
+ limited.pop();
+ nextCursor = (limited[limited.length - 1].updatedAt as Date).toISOString();
+ }
+
+ const convoMap: Record<string, unknown> = {};
+ limited.forEach((convo) => {
+ convoMap[convo.conversationId] = convo;
+ });
+
+ return { conversations: limited, nextCursor, convoMap };
+ } catch (error) {
+ logger.error('[getConvosQueried] Error getting conversations', error);
+ throw new Error('Error fetching conversations');
+ }
+ }
+
+ /**
+ * Gets conversation title, returning 'New Chat' as default.
+ */
+ async function getConvoTitle(user: string, conversationId: string) {
+ try {
+ const convo = await getConvo(user, conversationId);
+ if (convo && !convo.title) {
+ return null;
+ } else {
+ return convo?.title || 'New Chat';
+ }
+ } catch (error) {
+ logger.error('[getConvoTitle] Error getting conversation title', error);
+ throw new Error('Error getting conversation title');
+ }
+ }
+
+ /**
+ * Deletes conversations and their associated messages for a given user and filter.
+ */
+ async function deleteConvos(user: string, filter: FilterQuery<IConversation>) {
+ try {
+ const Conversation = mongoose.models.Conversation as Model<IConversation>;
+ const { deleteMessages } = getMessageMethods();
+ const userFilter = { ...filter, user };
+ const conversations = await Conversation.find(userFilter).select('conversationId');
+ const conversationIds = conversations.map((c) => c.conversationId);
+
+ if (!conversationIds.length) {
+ throw new Error('Conversation not found or already deleted.');
+ }
+
+ const deleteConvoResult = await Conversation.deleteMany(userFilter);
+
+ const deleteMessagesResult = await deleteMessages({
+ conversationId: { $in: conversationIds },
+ user,
+ });
+
+ return { ...deleteConvoResult, messages: deleteMessagesResult };
+ } catch (error) {
+ logger.error('[deleteConvos] Error deleting conversations and messages', error);
+ throw error;
+ }
+ }
+
+ return {
+ getConvoFiles,
+ searchConversation,
+ deleteNullOrEmptyConversations,
+ saveConvo,
+ bulkSaveConvos,
+ getConvosByCursor,
+ getConvosQueried,
+ getConvo,
+ getConvoTitle,
+ deleteConvos,
+ };
+}
diff --git a/api/models/ConversationTag.spec.js b/packages/data-schemas/src/methods/conversationTag.methods.spec.ts
similarity index 73%
rename from api/models/ConversationTag.spec.js
rename to packages/data-schemas/src/methods/conversationTag.methods.spec.ts
index bc7da919e1..0b4c6268d6 100644
--- a/api/models/ConversationTag.spec.js
+++ b/packages/data-schemas/src/methods/conversationTag.methods.spec.ts
@@ -1,13 +1,38 @@
-const mongoose = require('mongoose');
-const { MongoMemoryServer } = require('mongodb-memory-server');
-const { ConversationTag, Conversation } = require('~/db/models');
-const { deleteConversationTag } = require('./ConversationTag');
-
-let mongoServer;
+import mongoose from 'mongoose';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import { createConversationTagMethods } from './conversationTag';
+import { createModels } from '~/models';
+import type { IConversationTag } from '~/schema/conversationTag';
+import type { IConversation } from '..';
+
+jest.mock('~/config/winston', () => ({
+ error: jest.fn(),
+ warn: jest.fn(),
+ info: jest.fn(),
+ debug: jest.fn(),
+}));
+
+let mongoServer: InstanceType<typeof MongoMemoryServer>;
+let ConversationTag: mongoose.Model<IConversationTag>;
+let Conversation: mongoose.Model<IConversation>;
+let deleteConversationTag: ReturnType<typeof createConversationTagMethods>['deleteConversationTag'];
beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
- await mongoose.connect(mongoServer.getUri());
+ const mongoUri = mongoServer.getUri();
+
+ // Register models
+ const models = createModels(mongoose);
+ Object.assign(mongoose.models, models);
+
+ ConversationTag = mongoose.models.ConversationTag;
+ Conversation = mongoose.models.Conversation;
+
+ // Create methods from factory
+ const methods = createConversationTagMethods(mongoose);
+ deleteConversationTag = methods.deleteConversationTag;
+
+ await mongoose.connect(mongoUri);
});
afterAll(async () => {
@@ -47,7 +72,7 @@ describe('ConversationTag model - $pullAll operations', () => {
const result = await deleteConversationTag(userId, 'temp');
expect(result).toBeDefined();
- expect(result.tag).toBe('temp');
+ expect(result!.tag).toBe('temp');
const remaining = await ConversationTag.find({ user: userId }).lean();
expect(remaining).toHaveLength(0);
@@ -91,8 +116,8 @@ describe('ConversationTag model - $pullAll operations', () => {
const myConvo = await Conversation.findOne({ conversationId: 'mine' }).lean();
const theirConvo = await Conversation.findOne({ conversationId: 'theirs' }).lean();
- expect(myConvo.tags).toEqual([]);
- expect(theirConvo.tags).toEqual(['shared-name']);
+ expect(myConvo?.tags).toEqual([]);
+ expect(theirConvo?.tags).toEqual(['shared-name']);
});
it('should handle duplicate tags in conversations correctly', async () => {
@@ -108,7 +133,7 @@ describe('ConversationTag model - $pullAll operations', () => {
await deleteConversationTag(userId, 'dup');
const updated = await Conversation.findById(conv._id).lean();
- expect(updated.tags).toEqual(['other']);
+ expect(updated?.tags).toEqual(['other']);
});
});
});
diff --git a/packages/data-schemas/src/methods/conversationTag.ts b/packages/data-schemas/src/methods/conversationTag.ts
new file mode 100644
index 0000000000..af1e43babb
--- /dev/null
+++ b/packages/data-schemas/src/methods/conversationTag.ts
@@ -0,0 +1,312 @@
+import type { Model } from 'mongoose';
+import logger from '~/config/winston';
+
+interface IConversationTag {
+ user: string;
+ tag: string;
+ description?: string;
+ position: number;
+ count: number;
+ createdAt?: Date;
+ [key: string]: unknown;
+}
+
+export function createConversationTagMethods(mongoose: typeof import('mongoose')) {
+ /**
+ * Retrieves all conversation tags for a user.
+ */
+ async function getConversationTags(user: string) {
+ try {
+ const ConversationTag = mongoose.models.ConversationTag as Model<IConversationTag>;
+ return await ConversationTag.find({ user }).sort({ position: 1 }).lean();
+ } catch (error) {
+ logger.error('[getConversationTags] Error getting conversation tags', error);
+ throw new Error('Error getting conversation tags');
+ }
+ }
+
+ /**
+ * Creates a new conversation tag.
+ */
+ async function createConversationTag(
+ user: string,
+ data: {
+ tag: string;
+ description?: string;
+ addToConversation?: boolean;
+ conversationId?: string;
+ },
+ ) {
+ try {
+ const ConversationTag = mongoose.models.ConversationTag as Model<IConversationTag>;
+ const Conversation = mongoose.models.Conversation;
+ const { tag, description, addToConversation, conversationId } = data;
+
+ const existingTag = await ConversationTag.findOne({ user, tag }).lean();
+ if (existingTag) {
+ return existingTag;
+ }
+
+ const maxPosition = await ConversationTag.findOne({ user }).sort('-position').lean();
+ const position = (maxPosition?.position || 0) + 1;
+
+ const newTag = await ConversationTag.findOneAndUpdate(
+ { tag, user },
+ {
+ tag,
+ user,
+ count: addToConversation ? 1 : 0,
+ position,
+ description,
+ $setOnInsert: { createdAt: new Date() },
+ },
+ {
+ new: true,
+ upsert: true,
+ lean: true,
+ },
+ );
+
+ if (addToConversation && conversationId) {
+ await Conversation.findOneAndUpdate(
+ { user, conversationId },
+ { $addToSet: { tags: tag } },
+ { new: true },
+ );
+ }
+
+ return newTag;
+ } catch (error) {
+ logger.error('[createConversationTag] Error creating conversation tag', error);
+ throw new Error('Error creating conversation tag');
+ }
+ }
+
+ /**
+ * Adjusts positions of tags when a tag's position is changed.
+ */
+ async function adjustPositions(user: string, oldPosition: number, newPosition: number) {
+ if (oldPosition === newPosition) {
+ return;
+ }
+
+ const ConversationTag = mongoose.models.ConversationTag as Model<IConversationTag>;
+
+ const update =
+ oldPosition < newPosition ? { $inc: { position: -1 } } : { $inc: { position: 1 } };
+ const position =
+ oldPosition < newPosition
+ ? {
+ $gt: Math.min(oldPosition, newPosition),
+ $lte: Math.max(oldPosition, newPosition),
+ }
+ : {
+ $gte: Math.min(oldPosition, newPosition),
+ $lt: Math.max(oldPosition, newPosition),
+ };
+
+ await ConversationTag.updateMany({ user, position }, update);
+ }
+
+ /**
+ * Updates an existing conversation tag.
+ */
+ async function updateConversationTag(
+ user: string,
+ oldTag: string,
+ data: { tag?: string; description?: string; position?: number },
+ ) {
+ try {
+ const ConversationTag = mongoose.models.ConversationTag as Model<IConversationTag>;
+ const Conversation = mongoose.models.Conversation;
+ const { tag: newTag, description, position } = data;
+
+ const existingTag = await ConversationTag.findOne({ user, tag: oldTag }).lean();
+ if (!existingTag) {
+ return null;
+ }
+
+ if (newTag && newTag !== oldTag) {
+ const tagAlreadyExists = await ConversationTag.findOne({ user, tag: newTag }).lean();
+ if (tagAlreadyExists) {
+ throw new Error('Tag already exists');
+ }
+
+ await Conversation.updateMany({ user, tags: oldTag }, { $set: { 'tags.$': newTag } });
+ }
+
+ const updateData: Record<string, unknown> = {};
+ if (newTag) {
+ updateData.tag = newTag;
+ }
+ if (description !== undefined) {
+ updateData.description = description;
+ }
+ if (position !== undefined) {
+ await adjustPositions(user, existingTag.position, position);
+ updateData.position = position;
+ }
+
+ return await ConversationTag.findOneAndUpdate({ user, tag: oldTag }, updateData, {
+ new: true,
+ lean: true,
+ });
+ } catch (error) {
+ logger.error('[updateConversationTag] Error updating conversation tag', error);
+ throw new Error('Error updating conversation tag');
+ }
+ }
+
+ /**
+ * Deletes a conversation tag.
+ */
+ async function deleteConversationTag(user: string, tag: string) {
+ try {
+ const ConversationTag = mongoose.models.ConversationTag as Model<IConversationTag>;
+ const Conversation = mongoose.models.Conversation;
+
+ const deletedTag = await ConversationTag.findOneAndDelete({ user, tag }).lean();
+ if (!deletedTag) {
+ return null;
+ }
+
+ await Conversation.updateMany({ user, tags: tag }, { $pullAll: { tags: [tag] } });
+
+ await ConversationTag.updateMany(
+ { user, position: { $gt: deletedTag.position } },
+ { $inc: { position: -1 } },
+ );
+
+ return deletedTag;
+ } catch (error) {
+ logger.error('[deleteConversationTag] Error deleting conversation tag', error);
+ throw new Error('Error deleting conversation tag');
+ }
+ }
+
+ /**
+ * Updates tags for a specific conversation.
+ */
+ async function updateTagsForConversation(user: string, conversationId: string, tags: string[]) {
+ try {
+ const ConversationTag = mongoose.models.ConversationTag as Model<IConversationTag>;
+ const Conversation = mongoose.models.Conversation;
+
+ const conversation = await Conversation.findOne({ user, conversationId }).lean();
+ if (!conversation) {
+ throw new Error('Conversation not found');
+ }
+
+ const oldTags = new Set<string>(
+ ((conversation as Record<string, unknown>).tags as string[]) ?? [],
+ );
+ const newTags = new Set(tags);
+
+ const addedTags = [...newTags].filter((tag) => !oldTags.has(tag));
+ const removedTags = [...oldTags].filter((tag) => !newTags.has(tag));
+
+ const bulkOps: Array<{
+ updateOne: {
+ filter: Record<string, unknown>;
+ update: Record<string, unknown>;
+ upsert?: boolean;
+ };
+ }> = [];
+
+ for (const tag of addedTags) {
+ bulkOps.push({
+ updateOne: {
+ filter: { user, tag },
+ update: { $inc: { count: 1 } },
+ upsert: true,
+ },
+ });
+ }
+
+ for (const tag of removedTags) {
+ bulkOps.push({
+ updateOne: {
+ filter: { user, tag },
+ update: { $inc: { count: -1 } },
+ },
+ });
+ }
+
+ if (bulkOps.length > 0) {
+ await ConversationTag.bulkWrite(bulkOps);
+ }
+
+ const updatedConversation = (
+ await Conversation.findOneAndUpdate(
+ { user, conversationId },
+ { $set: { tags: [...newTags] } },
+ { new: true },
+ )
+ ).toObject();
+
+ return updatedConversation.tags;
+ } catch (error) {
+ logger.error('[updateTagsForConversation] Error updating tags', error);
+ throw new Error('Error updating tags for conversation');
+ }
+ }
+
+ /**
+ * Increments tag counts for existing tags only.
+ */
+ async function bulkIncrementTagCounts(user: string, tags: string[]) {
+ if (!tags || tags.length === 0) {
+ return;
+ }
+
+ try {
+ const ConversationTag = mongoose.models.ConversationTag as Model<IConversationTag>;
+ const uniqueTags = [...new Set(tags.filter(Boolean))];
+ if (uniqueTags.length === 0) {
+ return;
+ }
+
+ const bulkOps = uniqueTags.map((tag) => ({
+ updateOne: {
+ filter: { user, tag },
+ update: { $inc: { count: 1 } },
+ },
+ }));
+
+ const result = await ConversationTag.bulkWrite(bulkOps);
+ if (result && result.modifiedCount > 0) {
+ logger.debug(
+ `user: ${user} | Incremented tag counts - modified ${result.modifiedCount} tags`,
+ );
+ }
+ } catch (error) {
+ logger.error('[bulkIncrementTagCounts] Error incrementing tag counts', error);
+ }
+ }
+
+ /**
+ * Deletes all conversation tags matching the given filter.
+ */
+ async function deleteConversationTags(filter: Record<string, unknown>): Promise<number> {
+ try {
+ const ConversationTag = mongoose.models.ConversationTag as Model<IConversationTag>;
+ const result = await ConversationTag.deleteMany(filter);
+ return result.deletedCount;
+ } catch (error) {
+ logger.error('[deleteConversationTags] Error deleting conversation tags', error);
+ throw new Error('Error deleting conversation tags');
+ }
+ }
+
+ return {
+ getConversationTags,
+ createConversationTag,
+ updateConversationTag,
+ deleteConversationTag,
+ deleteConversationTags,
+ bulkIncrementTagCounts,
+ updateTagsForConversation,
+ };
+}
+
+export type ConversationTagMethods = ReturnType<typeof createConversationTagMethods>;
diff --git a/api/models/convoStructure.spec.js b/packages/data-schemas/src/methods/convoStructure.spec.ts
similarity index 69%
rename from api/models/convoStructure.spec.js
rename to packages/data-schemas/src/methods/convoStructure.spec.ts
index 440f21cb06..77a9913233 100644
--- a/api/models/convoStructure.spec.js
+++ b/packages/data-schemas/src/methods/convoStructure.spec.ts
@@ -1,13 +1,35 @@
-const mongoose = require('mongoose');
-const { buildTree } = require('librechat-data-provider');
-const { MongoMemoryServer } = require('mongodb-memory-server');
-const { getMessages, bulkSaveMessages } = require('./Message');
-const { Message } = require('~/db/models');
+import mongoose from 'mongoose';
+import type { TMessage } from 'librechat-data-provider';
+import { buildTree } from 'librechat-data-provider';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import { createModels } from '~/models';
+import { createMessageMethods } from './message';
+import type { IMessage } from '..';
+
+jest.mock('~/config/winston', () => ({
+ error: jest.fn(),
+ warn: jest.fn(),
+ info: jest.fn(),
+ debug: jest.fn(),
+}));
+
+let mongod: InstanceType<typeof MongoMemoryServer>;
+let Message: mongoose.Model<IMessage>;
+let getMessages: ReturnType<typeof createMessageMethods>['getMessages'];
+let bulkSaveMessages: ReturnType<typeof createMessageMethods>['bulkSaveMessages'];
-let mongod;
beforeAll(async () => {
mongod = await MongoMemoryServer.create();
const uri = mongod.getUri();
+
+ const models = createModels(mongoose);
+ Object.assign(mongoose.models, models);
+ Message = mongoose.models.Message;
+
+ const methods = createMessageMethods(mongoose);
+ getMessages = methods.getMessages;
+ bulkSaveMessages = methods.bulkSaveMessages;
+
await mongoose.connect(uri);
});
@@ -61,11 +83,13 @@ describe('Conversation Structure Tests', () => {
// Add common properties to all messages
messages.forEach((msg) => {
- msg.conversationId = conversationId;
- msg.user = userId;
- msg.isCreatedByUser = false;
- msg.error = false;
- msg.unfinished = false;
+ Object.assign(msg, {
+ conversationId,
+ user: userId,
+ isCreatedByUser: false,
+ error: false,
+ unfinished: false,
+ });
});
// Save messages with overrideTimestamp omitted (default is false)
@@ -75,10 +99,10 @@ describe('Conversation Structure Tests', () => {
const retrievedMessages = await getMessages({ conversationId, user: userId });
// Build tree
- const tree = buildTree({ messages: retrievedMessages });
+ const tree = buildTree({ messages: retrievedMessages as TMessage[] });
// Check if the tree is incorrect (folded/corrupted)
- expect(tree.length).toBeGreaterThan(1); // Should have multiple root messages, indicating corruption
+ expect(tree!.length).toBeGreaterThan(1); // Should have multiple root messages, indicating corruption
});
test('Fix: Conversation structure maintained with more than 16 messages', async () => {
@@ -102,17 +126,17 @@ describe('Conversation Structure Tests', () => {
const retrievedMessages = await getMessages({ conversationId, user: userId });
// Build tree
- const tree = buildTree({ messages: retrievedMessages });
+ const tree = buildTree({ messages: retrievedMessages as TMessage[] });
// Check if the tree is correct
- expect(tree.length).toBe(1); // Should have only one root message
- let currentNode = tree[0];
+ expect(tree!.length).toBe(1); // Should have only one root message
+ let currentNode = tree![0];
for (let i = 1; i < 20; i++) {
- expect(currentNode.children.length).toBe(1);
- currentNode = currentNode.children[0];
+ expect(currentNode.children!.length).toBe(1);
+ currentNode = currentNode.children![0];
expect(currentNode.text).toBe(`Message ${i}`);
}
- expect(currentNode.children.length).toBe(0); // Last message should have no children
+ expect(currentNode.children!.length).toBe(0); // Last message should have no children
});
test('Simulate MongoDB ordering issue with more than 16 messages and close timestamps', async () => {
@@ -131,15 +155,13 @@ describe('Conversation Structure Tests', () => {
// Add common properties to all messages
messages.forEach((msg) => {
- msg.isCreatedByUser = false;
- msg.error = false;
- msg.unfinished = false;
+ Object.assign(msg, { isCreatedByUser: false, error: false, unfinished: false });
});
await bulkSaveMessages(messages, true);
const retrievedMessages = await getMessages({ conversationId, user: userId });
- const tree = buildTree({ messages: retrievedMessages });
- expect(tree.length).toBeGreaterThan(1);
+ const tree = buildTree({ messages: retrievedMessages as TMessage[] });
+ expect(tree!.length).toBeGreaterThan(1);
});
test('Fix: Preserve order with more than 16 messages by maintaining original timestamps', async () => {
@@ -158,9 +180,7 @@ describe('Conversation Structure Tests', () => {
// Add common properties to all messages
messages.forEach((msg) => {
- msg.isCreatedByUser = false;
- msg.error = false;
- msg.unfinished = false;
+ Object.assign(msg, { isCreatedByUser: false, error: false, unfinished: false });
});
// Save messages with overriding timestamps (preserve original timestamps)
@@ -170,17 +190,17 @@ describe('Conversation Structure Tests', () => {
const retrievedMessages = await getMessages({ conversationId, user: userId });
// Build tree
- const tree = buildTree({ messages: retrievedMessages });
+ const tree = buildTree({ messages: retrievedMessages as TMessage[] });
// Check if the tree is correct
- expect(tree.length).toBe(1); // Should have only one root message
- let currentNode = tree[0];
+ expect(tree!.length).toBe(1); // Should have only one root message
+ let currentNode = tree![0];
for (let i = 1; i < 20; i++) {
- expect(currentNode.children.length).toBe(1);
- currentNode = currentNode.children[0];
+ expect(currentNode.children!.length).toBe(1);
+ currentNode = currentNode.children![0];
expect(currentNode.text).toBe(`Message ${i}`);
}
- expect(currentNode.children.length).toBe(0); // Last message should have no children
+ expect(currentNode.children!.length).toBe(0); // Last message should have no children
});
test('Random order dates between parent and children messages', async () => {
@@ -217,11 +237,13 @@ describe('Conversation Structure Tests', () => {
// Add common properties to all messages
messages.forEach((msg) => {
- msg.conversationId = conversationId;
- msg.user = userId;
- msg.isCreatedByUser = false;
- msg.error = false;
- msg.unfinished = false;
+ Object.assign(msg, {
+ conversationId,
+ user: userId,
+ isCreatedByUser: false,
+ error: false,
+ unfinished: false,
+ });
});
// Save messages with overrideTimestamp set to true
@@ -241,16 +263,16 @@ describe('Conversation Structure Tests', () => {
);
// Build tree
- const tree = buildTree({ messages: retrievedMessages });
+ const tree = buildTree({ messages: retrievedMessages as TMessage[] });
// Debug log to see the tree structure
console.log(
'Tree structure:',
- tree.map((root) => ({
+ tree!.map((root) => ({
messageId: root.messageId,
- children: root.children.map((child) => ({
+ children: root.children!.map((child) => ({
messageId: child.messageId,
- children: child.children.map((grandchild) => ({
+ children: child.children!.map((grandchild) => ({
messageId: grandchild.messageId,
})),
})),
@@ -262,14 +284,14 @@ describe('Conversation Structure Tests', () => {
// Check if messages are properly linked
const parentMsg = retrievedMessages.find((msg) => msg.messageId === 'parent');
- expect(parentMsg.parentMessageId).toBeNull(); // Parent should have null parentMessageId
+ expect(parentMsg!.parentMessageId).toBeNull(); // Parent should have null parentMessageId
const childMsg1 = retrievedMessages.find((msg) => msg.messageId === 'child1');
- expect(childMsg1.parentMessageId).toBe('parent');
+ expect(childMsg1!.parentMessageId).toBe('parent');
// Then check tree structure
- expect(tree.length).toBe(1); // Should have only one root message
- expect(tree[0].messageId).toBe('parent');
- expect(tree[0].children.length).toBe(2); // Should have two children
+ expect(tree!.length).toBe(1); // Should have only one root message
+ expect(tree![0].messageId).toBe('parent');
+ expect(tree![0].children!.length).toBe(2); // Should have two children
});
});
diff --git a/packages/data-schemas/src/methods/file.acl.spec.ts b/packages/data-schemas/src/methods/file.acl.spec.ts
new file mode 100644
index 0000000000..240b535bd8
--- /dev/null
+++ b/packages/data-schemas/src/methods/file.acl.spec.ts
@@ -0,0 +1,405 @@
+import mongoose from 'mongoose';
+import { v4 as uuidv4 } from 'uuid';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import {
+ ResourceType,
+ AccessRoleIds,
+ PrincipalType,
+ PermissionBits,
+} from 'librechat-data-provider';
+import type { AccessRole as TAccessRole, AclEntry as TAclEntry } from '..';
+import type { Types } from 'mongoose';
+import { createAclEntryMethods } from './aclEntry';
+import { createModels } from '../models';
+import { createMethods } from './index';
+
+/** Lean access role object from .lean() */
+type LeanAccessRole = TAccessRole & { _id: mongoose.Types.ObjectId };
+
+/** Lean ACL entry from .lean() */
+type LeanAclEntry = TAclEntry & { _id: mongoose.Types.ObjectId };
+
+/** Tool resources shape for agent file access */
+type AgentToolResources = {
+ file_search?: { file_ids?: string[] };
+ code_interpreter?: { file_ids?: string[] };
+};
+
+let File: mongoose.Model<unknown>;
+let Agent: mongoose.Model<unknown>;
+let AclEntry: mongoose.Model<unknown>;
+let AccessRole: mongoose.Model<unknown>;
+let User: mongoose.Model<unknown>;
+let methods: ReturnType<typeof createMethods>;
+let aclMethods: ReturnType<typeof createAclEntryMethods>;
+
+describe('File Access Control', () => {
+ let mongoServer: MongoMemoryServer;
+
+ beforeAll(async () => {
+ mongoServer = await MongoMemoryServer.create();
+ const mongoUri = mongoServer.getUri();
+ await mongoose.connect(mongoUri);
+
+ createModels(mongoose);
+ File = mongoose.models.File;
+ Agent = mongoose.models.Agent;
+ AclEntry = mongoose.models.AclEntry;
+ AccessRole = mongoose.models.AccessRole;
+ User = mongoose.models.User;
+
+ methods = createMethods(mongoose);
+ aclMethods = createAclEntryMethods(mongoose);
+
+ // Seed default access roles
+ await methods.seedDefaultRoles();
+ });
+
+ afterAll(async () => {
+ const collections = mongoose.connection.collections;
+ for (const key in collections) {
+ await collections[key].deleteMany({});
+ }
+ await mongoose.disconnect();
+ await mongoServer.stop();
+ });
+
+ beforeEach(async () => {
+ await File.deleteMany({});
+ await Agent.deleteMany({});
+ await AclEntry.deleteMany({});
+ await User.deleteMany({});
+ });
+
+ describe('File ACL entry operations', () => {
+ it('should create ACL entries for agent file access', async () => {
+ const userId = new mongoose.Types.ObjectId();
+ const authorId = new mongoose.Types.ObjectId();
+ const agentId = uuidv4();
+ const fileIds = [uuidv4(), uuidv4(), uuidv4(), uuidv4()];
+
+ // Create users
+ await User.create({
+ _id: userId,
+ email: '[email protected]',
+ emailVerified: true,
+ provider: 'local',
+ });
+
+ await User.create({
+ _id: authorId,
+ email: '[email protected]',
+ emailVerified: true,
+ provider: 'local',
+ });
+
+ // Create files
+ for (const fileId of fileIds) {
+ await methods.createFile({
+ user: authorId,
+ file_id: fileId,
+ filename: `file-${fileId}.txt`,
+ filepath: `/uploads/${fileId}`,
+ });
+ }
+
+ // Create agent with only first two files attached
+ const agent = await methods.createAgent({
+ id: agentId,
+ name: 'Test Agent',
+ author: authorId,
+ model: 'gpt-4',
+ provider: 'openai',
+ tool_resources: {
+ file_search: {
+ file_ids: [fileIds[0], fileIds[1]],
+ },
+ },
+ });
+
+ // Grant EDIT permission to user on the agent
+ const editorRole = (await AccessRole.findOne({
+ accessRoleId: AccessRoleIds.AGENT_EDITOR,
+ }).lean()) as LeanAccessRole | null;
+
+ if (editorRole) {
+ await aclMethods.grantPermission(
+ PrincipalType.USER,
+ userId,
+ ResourceType.AGENT,
+ agent._id as string | Types.ObjectId,
+ editorRole.permBits,
+ authorId,
+ undefined,
+ editorRole._id,
+ );
+ }
+
+ // Verify ACL entry exists for the user
+ const aclEntry = (await AclEntry.findOne({
+ principalType: PrincipalType.USER,
+ principalId: userId,
+ resourceType: ResourceType.AGENT,
+ resourceId: agent._id,
+ }).lean()) as LeanAclEntry | null;
+
+ expect(aclEntry).toBeTruthy();
+
+ // Check that agent has correct file_ids in tool_resources
+ const agentRecord = await methods.getAgent({ id: agentId });
+ const toolResources = agentRecord?.tool_resources as AgentToolResources | undefined;
+ expect(toolResources?.file_search?.file_ids).toContain(fileIds[0]);
+ expect(toolResources?.file_search?.file_ids).toContain(fileIds[1]);
+ expect(toolResources?.file_search?.file_ids).not.toContain(fileIds[2]);
+ expect(toolResources?.file_search?.file_ids).not.toContain(fileIds[3]);
+ });
+
+ it('should grant access to agent author via ACL', async () => {
+ const authorId = new mongoose.Types.ObjectId();
+ const agentId = uuidv4();
+
+ await User.create({
+ _id: authorId,
+ email: '[email protected]',
+ emailVerified: true,
+ provider: 'local',
+ });
+
+ const agent = await methods.createAgent({
+ id: agentId,
+ name: 'Test Agent',
+ author: authorId,
+ model: 'gpt-4',
+ provider: 'openai',
+ });
+
+ // Grant owner permissions
+ const ownerRole = (await AccessRole.findOne({
+ accessRoleId: AccessRoleIds.AGENT_OWNER,
+ }).lean()) as LeanAccessRole | null;
+
+ if (ownerRole) {
+ await aclMethods.grantPermission(
+ PrincipalType.USER,
+ authorId,
+ ResourceType.AGENT,
+ agent._id as string | Types.ObjectId,
+ ownerRole.permBits,
+ authorId,
+ undefined,
+ ownerRole._id,
+ );
+ }
+
+ // Author should have full permission bits on the agent
+ const hasView = await aclMethods.hasPermission(
+ [{ principalType: PrincipalType.USER, principalId: authorId }],
+ ResourceType.AGENT,
+ agent._id as string | Types.ObjectId,
+ PermissionBits.VIEW,
+ );
+
+ const hasEdit = await aclMethods.hasPermission(
+ [{ principalType: PrincipalType.USER, principalId: authorId }],
+ ResourceType.AGENT,
+ agent._id as string | Types.ObjectId,
+ PermissionBits.EDIT,
+ );
+
+ expect(hasView).toBe(true);
+ expect(hasEdit).toBe(true);
+ });
+
+ it('should deny access when no ACL entry exists', async () => {
+ const userId = new mongoose.Types.ObjectId();
+ const agentId = new mongoose.Types.ObjectId();
+
+ const hasAccess = await aclMethods.hasPermission(
+ [{ principalType: PrincipalType.USER, principalId: userId }],
+ ResourceType.AGENT,
+ agentId,
+ PermissionBits.VIEW,
+ );
+
+ expect(hasAccess).toBe(false);
+ });
+
+ it('should deny EDIT when user only has VIEW permission', async () => {
+ const userId = new mongoose.Types.ObjectId();
+ const authorId = new mongoose.Types.ObjectId();
+ const agentId = uuidv4();
+
+ await User.create({
+ _id: userId,
+ email: '[email protected]',
+ emailVerified: true,
+ provider: 'local',
+ });
+
+ await User.create({
+ _id: authorId,
+ email: '[email protected]',
+ emailVerified: true,
+ provider: 'local',
+ });
+
+ const agent = await methods.createAgent({
+ id: agentId,
+ name: 'View-Only Agent',
+ author: authorId,
+ model: 'gpt-4',
+ provider: 'openai',
+ });
+
+ // Grant only VIEW permission
+ const viewerRole = (await AccessRole.findOne({
+ accessRoleId: AccessRoleIds.AGENT_VIEWER,
+ }).lean()) as LeanAccessRole | null;
+
+ if (viewerRole) {
+ await aclMethods.grantPermission(
+ PrincipalType.USER,
+ userId,
+ ResourceType.AGENT,
+ agent._id as string | Types.ObjectId,
+ viewerRole.permBits,
+ authorId,
+ undefined,
+ viewerRole._id,
+ );
+ }
+
+ const canView = await aclMethods.hasPermission(
+ [{ principalType: PrincipalType.USER, principalId: userId }],
+ ResourceType.AGENT,
+ agent._id as string | Types.ObjectId,
+ PermissionBits.VIEW,
+ );
+
+ const canEdit = await aclMethods.hasPermission(
+ [{ principalType: PrincipalType.USER, principalId: userId }],
+ ResourceType.AGENT,
+ agent._id as string | Types.ObjectId,
+ PermissionBits.EDIT,
+ );
+
+ expect(canView).toBe(true);
+ expect(canEdit).toBe(false);
+ });
+
+ it('should support role-based permission grants', async () => {
+ const userId = new mongoose.Types.ObjectId();
+ const authorId = new mongoose.Types.ObjectId();
+ const agentId = uuidv4();
+
+ await User.create({
+ _id: userId,
+ email: '[email protected]',
+ emailVerified: true,
+ provider: 'local',
+ role: 'ADMIN',
+ });
+
+ await User.create({
+ _id: authorId,
+ email: '[email protected]',
+ emailVerified: true,
+ provider: 'local',
+ });
+
+ const agent = await methods.createAgent({
+ id: agentId,
+ name: 'Test Agent',
+ author: authorId,
+ model: 'gpt-4',
+ provider: 'openai',
+ });
+
+ // Grant permission to ADMIN role
+ const editorRole = (await AccessRole.findOne({
+ accessRoleId: AccessRoleIds.AGENT_EDITOR,
+ }).lean()) as LeanAccessRole | null;
+
+ if (editorRole) {
+ await aclMethods.grantPermission(
+ PrincipalType.ROLE,
+ 'ADMIN',
+ ResourceType.AGENT,
+ agent._id as string | Types.ObjectId,
+ editorRole.permBits,
+ authorId,
+ undefined,
+ editorRole._id,
+ );
+ }
+
+ // User with ADMIN role should have access through role-based ACL
+ const hasAccess = await aclMethods.hasPermission(
+ [
+ { principalType: PrincipalType.USER, principalId: userId },
+ {
+ principalType: PrincipalType.ROLE,
+ principalId: 'ADMIN' as unknown as mongoose.Types.ObjectId,
+ },
+ ],
+ ResourceType.AGENT,
+ agent._id as string | Types.ObjectId,
+ PermissionBits.VIEW,
+ );
+
+ expect(hasAccess).toBe(true);
+ });
+ });
+
+ describe('getFiles with file queries', () => {
+ it('should return files created by user', async () => {
+ const userId = new mongoose.Types.ObjectId();
+ const fileId1 = `file_${uuidv4()}`;
+ const fileId2 = `file_${uuidv4()}`;
+
+ await methods.createFile({
+ file_id: fileId1,
+ user: userId,
+ filename: 'file1.txt',
+ filepath: '/uploads/file1.txt',
+ type: 'text/plain',
+ bytes: 100,
+ });
+
+ await methods.createFile({
+ file_id: fileId2,
+ user: new mongoose.Types.ObjectId(),
+ filename: 'file2.txt',
+ filepath: '/uploads/file2.txt',
+ type: 'text/plain',
+ bytes: 200,
+ });
+
+ const files = await methods.getFiles({ file_id: { $in: [fileId1, fileId2] } });
+ expect(files).toHaveLength(2);
+ });
+
+ it('should return all files matching query', async () => {
+ const userId = new mongoose.Types.ObjectId();
+ const fileId1 = `file_${uuidv4()}`;
+ const fileId2 = `file_${uuidv4()}`;
+
+ await methods.createFile({
+ file_id: fileId1,
+ user: userId,
+ filename: 'file1.txt',
+ filepath: '/uploads/file1.txt',
+ });
+
+ await methods.createFile({
+ file_id: fileId2,
+ user: userId,
+ filename: 'file2.txt',
+ filepath: '/uploads/file2.txt',
+ });
+
+ const files = await methods.getFiles({ user: userId });
+ expect(files).toHaveLength(2);
+ });
+ });
+});
diff --git a/packages/data-schemas/src/methods/index.ts b/packages/data-schemas/src/methods/index.ts
index 07e7cefc24..6246d74343 100644
--- a/packages/data-schemas/src/methods/index.ts
+++ b/packages/data-schemas/src/methods/index.ts
@@ -1,6 +1,6 @@
import { createSessionMethods, DEFAULT_REFRESH_TOKEN_EXPIRY, type SessionMethods } from './session';
import { createTokenMethods, type TokenMethods } from './token';
-import { createRoleMethods, type RoleMethods } from './role';
+import { createRoleMethods, type RoleMethods, type RoleDeps } from './role';
import { createUserMethods, DEFAULT_SESSION_EXPIRY, type UserMethods } from './user';
export { DEFAULT_REFRESH_TOKEN_EXPIRY, DEFAULT_SESSION_EXPIRY };
@@ -21,7 +21,34 @@ import { createAccessRoleMethods, type AccessRoleMethods } from './accessRole';
import { createUserGroupMethods, type UserGroupMethods } from './userGroup';
import { createAclEntryMethods, type AclEntryMethods } from './aclEntry';
import { createShareMethods, type ShareMethods } from './share';
+/* Tier 1 — Simple CRUD */
+import { createActionMethods, type ActionMethods } from './action';
+import { createAssistantMethods, type AssistantMethods } from './assistant';
+import { createBannerMethods, type BannerMethods } from './banner';
+import { createToolCallMethods, type ToolCallMethods } from './toolCall';
+import { createCategoriesMethods, type CategoriesMethods } from './categories';
+import { createPresetMethods, type PresetMethods } from './preset';
+/* Tier 2 — Moderate (service deps injected) */
+import { createConversationTagMethods, type ConversationTagMethods } from './conversationTag';
+import { createMessageMethods, type MessageMethods } from './message';
+import { createConversationMethods, type ConversationMethods } from './conversation';
+/* Tier 3 — Complex (heavier injection) */
+import {
+ createTxMethods,
+ type TxMethods,
+ type TxDeps,
+ tokenValues,
+ cacheTokenValues,
+ premiumTokenValues,
+ defaultRate,
+} from './tx';
import { createTransactionMethods, type TransactionMethods } from './transaction';
+import { createSpendTokensMethods, type SpendTokensMethods } from './spendTokens';
+import { createPromptMethods, type PromptMethods, type PromptDeps } from './prompt';
+/* Tier 5 — Agent */
+import { createAgentMethods, type AgentMethods, type AgentDeps } from './agent';
+
+export { tokenValues, cacheTokenValues, premiumTokenValues, defaultRate };
export type AllMethods = UserMethods &
SessionMethods &
@@ -38,18 +65,105 @@ export type AllMethods = UserMethods &
ShareMethods &
AccessRoleMethods &
PluginAuthMethods &
- TransactionMethods;
+ ActionMethods &
+ AssistantMethods &
+ BannerMethods &
+ ToolCallMethods &
+ CategoriesMethods &
+ PresetMethods &
+ ConversationTagMethods &
+ MessageMethods &
+ ConversationMethods &
+ TxMethods &
+ TransactionMethods &
+ SpendTokensMethods &
+ PromptMethods &
+ AgentMethods;
+
+/** Dependencies injected from the api layer into createMethods */
+export interface CreateMethodsDeps {
+ /** Matches a model name to a canonical key. From @librechat/api. */
+ matchModelName?: (model: string, endpoint?: string) => string | undefined;
+ /** Finds the first key in values whose key is a substring of model. From @librechat/api. */
+ findMatchingPattern?: (model: string, values: Record<string, unknown>) => string | undefined;
+ /** Removes all ACL permissions for a resource. From PermissionService. */
+ removeAllPermissions?: (params: { resourceType: string; resourceId: unknown }) => Promise<void>;
+ /** Returns a cache store for the given key. From getLogStores. */
+ getCache?: RoleDeps['getCache'];
+}
/**
* Creates all database methods for all collections
* @param mongoose - Mongoose instance
+ * @param deps - Optional dependencies injected from the api layer
*/
-export function createMethods(mongoose: typeof import('mongoose')): AllMethods {
+export function createMethods(
+ mongoose: typeof import('mongoose'),
+ deps: CreateMethodsDeps = {},
+): AllMethods {
+ // Tier 3: tx methods need matchModelName and findMatchingPattern
+ const txDeps: TxDeps = {
+ matchModelName: deps.matchModelName ?? (() => undefined),
+ findMatchingPattern: deps.findMatchingPattern ?? (() => undefined),
+ };
+ const txMethods = createTxMethods(mongoose, txDeps);
+
+ // Tier 3: transaction methods need tx's getMultiplier/getCacheMultiplier
+ const transactionMethods = createTransactionMethods(mongoose, {
+ getMultiplier: txMethods.getMultiplier,
+ getCacheMultiplier: txMethods.getCacheMultiplier,
+ });
+
+ // Tier 3: spendTokens methods need transaction methods
+ const spendTokensMethods = createSpendTokensMethods(mongoose, {
+ createTransaction: transactionMethods.createTransaction,
+ createStructuredTransaction: transactionMethods.createStructuredTransaction,
+ });
+
+ const messageMethods = createMessageMethods(mongoose);
+
+ const conversationMethods = createConversationMethods(mongoose, {
+ getMessages: messageMethods.getMessages,
+ deleteMessages: messageMethods.deleteMessages,
+ });
+
+ // ACL entry methods (used internally for removeAllPermissions)
+ const aclEntryMethods = createAclEntryMethods(mongoose);
+
+ // Internal removeAllPermissions: use deleteAclEntries from aclEntryMethods
+ // instead of requiring it as an external dep from PermissionService
+ const removeAllPermissions =
+ deps.removeAllPermissions ??
+ (async ({ resourceType, resourceId }: { resourceType: string; resourceId: unknown }) => {
+ await aclEntryMethods.deleteAclEntries({ resourceType, resourceId });
+ });
+
+ const promptDeps: PromptDeps = {
+ removeAllPermissions,
+ getSoleOwnedResourceIds: aclEntryMethods.getSoleOwnedResourceIds,
+ };
+ const promptMethods = createPromptMethods(mongoose, promptDeps);
+
+ // Role methods with optional cache injection
+ const roleDeps: RoleDeps = { getCache: deps.getCache };
+ const roleMethods = createRoleMethods(mongoose, roleDeps);
+
+ // Tier 1: action methods (created as variable for agent dependency)
+ const actionMethods = createActionMethods(mongoose);
+
+ // Tier 5: agent methods need removeAllPermissions + getActions
+ const agentDeps: AgentDeps = {
+ removeAllPermissions,
+ getActions: actionMethods.getActions,
+ getSoleOwnedResourceIds: aclEntryMethods.getSoleOwnedResourceIds,
+ };
+ const agentMethods = createAgentMethods(mongoose, agentDeps);
+
return {
...createUserMethods(mongoose),
...createSessionMethods(mongoose),
...createTokenMethods(mongoose),
- ...createRoleMethods(mongoose),
+ ...roleMethods,
...createKeyMethods(mongoose),
...createFileMethods(mongoose),
...createMemoryMethods(mongoose),
@@ -58,10 +172,27 @@ export function createMethods(mongoose: typeof import('mongoose')): AllMethods {
...createMCPServerMethods(mongoose),
...createAccessRoleMethods(mongoose),
...createUserGroupMethods(mongoose),
- ...createAclEntryMethods(mongoose),
+ ...aclEntryMethods,
...createShareMethods(mongoose),
...createPluginAuthMethods(mongoose),
- ...createTransactionMethods(mongoose),
+ /* Tier 1 */
+ ...actionMethods,
+ ...createAssistantMethods(mongoose),
+ ...createBannerMethods(mongoose),
+ ...createToolCallMethods(mongoose),
+ ...createCategoriesMethods(mongoose),
+ ...createPresetMethods(mongoose),
+ /* Tier 2 */
+ ...createConversationTagMethods(mongoose),
+ ...messageMethods,
+ ...conversationMethods,
+ /* Tier 3 */
+ ...txMethods,
+ ...transactionMethods,
+ ...spendTokensMethods,
+ ...promptMethods,
+ /* Tier 5 */
+ ...agentMethods,
};
}
@@ -81,5 +212,18 @@ export type {
ShareMethods,
AccessRoleMethods,
PluginAuthMethods,
+ ActionMethods,
+ AssistantMethods,
+ BannerMethods,
+ ToolCallMethods,
+ CategoriesMethods,
+ PresetMethods,
+ ConversationTagMethods,
+ MessageMethods,
+ ConversationMethods,
+ TxMethods,
TransactionMethods,
+ SpendTokensMethods,
+ PromptMethods,
+ AgentMethods,
};
diff --git a/packages/data-schemas/src/methods/memory.ts b/packages/data-schemas/src/methods/memory.ts
index becb063f3d..749fbc9cf1 100644
--- a/packages/data-schemas/src/methods/memory.ts
+++ b/packages/data-schemas/src/methods/memory.ts
@@ -158,12 +158,28 @@ export function createMemoryMethods(mongoose: typeof import('mongoose')) {
}
}
+ /**
+ * Deletes all memory entries for a user
+ */
+ async function deleteAllUserMemories(userId: string | Types.ObjectId): Promise<number> {
+ try {
+ const MemoryEntry = mongoose.models.MemoryEntry;
+ const result = await MemoryEntry.deleteMany({ userId });
+ return result.deletedCount;
+ } catch (error) {
+ throw new Error(
+ `Failed to delete all user memories: ${error instanceof Error ? error.message : 'Unknown error'}`,
+ );
+ }
+ }
+
return {
setMemory,
createMemory,
deleteMemory,
getAllUserMemories,
getFormattedMemories,
+ deleteAllUserMemories,
};
}
diff --git a/api/models/Message.spec.js b/packages/data-schemas/src/methods/message.spec.ts
similarity index 67%
rename from api/models/Message.spec.js
rename to packages/data-schemas/src/methods/message.spec.ts
index 39b5b4337c..ac85a035b7 100644
--- a/api/models/Message.spec.js
+++ b/packages/data-schemas/src/methods/message.spec.ts
@@ -1,52 +1,73 @@
-const mongoose = require('mongoose');
-const { v4: uuidv4 } = require('uuid');
-const { messageSchema } = require('@librechat/data-schemas');
-const { MongoMemoryServer } = require('mongodb-memory-server');
-
-const {
- saveMessage,
- getMessages,
- updateMessage,
- deleteMessages,
- bulkSaveMessages,
- updateMessageText,
- deleteMessagesSince,
-} = require('./Message');
-
-jest.mock('~/server/services/Config/app');
-
-/**
- * @type {import('mongoose').Model<import('@librechat/data-schemas').IMessage>}
- */
-let Message;
+import mongoose from 'mongoose';
+import { v4 as uuidv4 } from 'uuid';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import type { IMessage } from '..';
+import { createMessageMethods } from './message';
+import { createModels } from '../models';
+
+jest.mock('~/config/winston', () => ({
+ error: jest.fn(),
+ warn: jest.fn(),
+ info: jest.fn(),
+ debug: jest.fn(),
+}));
+
+let mongoServer: InstanceType<typeof MongoMemoryServer>;
+let Message: mongoose.Model<IMessage>;
+let saveMessage: ReturnType<typeof createMessageMethods>['saveMessage'];
+let getMessages: ReturnType<typeof createMessageMethods>['getMessages'];
+let updateMessage: ReturnType<typeof createMessageMethods>['updateMessage'];
+let deleteMessages: ReturnType<typeof createMessageMethods>['deleteMessages'];
+let bulkSaveMessages: ReturnType<typeof createMessageMethods>['bulkSaveMessages'];
+let updateMessageText: ReturnType<typeof createMessageMethods>['updateMessageText'];
+let deleteMessagesSince: ReturnType<typeof createMessageMethods>['deleteMessagesSince'];
+
+beforeAll(async () => {
+ mongoServer = await MongoMemoryServer.create();
+ const mongoUri = mongoServer.getUri();
+
+ const models = createModels(mongoose);
+ Object.assign(mongoose.models, models);
+ Message = mongoose.models.Message;
+
+ const methods = createMessageMethods(mongoose);
+ saveMessage = methods.saveMessage;
+ getMessages = methods.getMessages;
+ updateMessage = methods.updateMessage;
+ deleteMessages = methods.deleteMessages;
+ bulkSaveMessages = methods.bulkSaveMessages;
+ updateMessageText = methods.updateMessageText;
+ deleteMessagesSince = methods.deleteMessagesSince;
+
+ await mongoose.connect(mongoUri);
+});
-describe('Message Operations', () => {
- let mongoServer;
- let mockReq;
- let mockMessageData;
-
- beforeAll(async () => {
- mongoServer = await MongoMemoryServer.create();
- const mongoUri = mongoServer.getUri();
- Message = mongoose.models.Message || mongoose.model('Message', messageSchema);
- await mongoose.connect(mongoUri);
- });
+afterAll(async () => {
+ await mongoose.disconnect();
+ await mongoServer.stop();
+});
- afterAll(async () => {
- await mongoose.disconnect();
- await mongoServer.stop();
- });
+describe('Message Operations', () => {
+ let mockCtx: {
+ userId: string;
+ isTemporary?: boolean;
+ interfaceConfig?: { temporaryChatRetention?: number };
+ };
+ let mockMessageData: Partial<IMessage> = {
+ messageId: 'msg123',
+ conversationId: uuidv4(),
+ text: 'Hello, world!',
+ user: 'user123',
+ };
beforeEach(async () => {
// Clear database
await Message.deleteMany({});
- mockReq = {
- user: { id: 'user123' },
- config: {
- interfaceConfig: {
- temporaryChatRetention: 24, // Default 24 hours
- },
+ mockCtx = {
+ userId: 'user123',
+ interfaceConfig: {
+ temporaryChatRetention: 24, // Default 24 hours
},
};
@@ -60,26 +81,26 @@ describe('Message Operations', () => {
describe('saveMessage', () => {
it('should save a message for an authenticated user', async () => {
- const result = await saveMessage(mockReq, mockMessageData);
+ const result = await saveMessage(mockCtx, mockMessageData);
- expect(result.messageId).toBe('msg123');
- expect(result.user).toBe('user123');
- expect(result.text).toBe('Hello, world!');
+ expect(result?.messageId).toBe('msg123');
+ expect(result?.user).toBe('user123');
+ expect(result?.text).toBe('Hello, world!');
// Verify the message was actually saved to the database
const savedMessage = await Message.findOne({ messageId: 'msg123', user: 'user123' });
expect(savedMessage).toBeTruthy();
- expect(savedMessage.text).toBe('Hello, world!');
+ expect(savedMessage?.text).toBe('Hello, world!');
});
it('should throw an error for unauthenticated user', async () => {
- mockReq.user = null;
- await expect(saveMessage(mockReq, mockMessageData)).rejects.toThrow('User not authenticated');
+ mockCtx.userId = null as unknown as string;
+ await expect(saveMessage(mockCtx, mockMessageData)).rejects.toThrow('User not authenticated');
});
it('should handle invalid conversation ID gracefully', async () => {
mockMessageData.conversationId = 'invalid-id';
- const result = await saveMessage(mockReq, mockMessageData);
+ const result = await saveMessage(mockCtx, mockMessageData);
expect(result).toBeUndefined();
});
});
@@ -87,35 +108,38 @@ describe('Message Operations', () => {
describe('updateMessageText', () => {
it('should update message text for the authenticated user', async () => {
// First save a message
- await saveMessage(mockReq, mockMessageData);
+ await saveMessage(mockCtx, mockMessageData);
// Then update it
- await updateMessageText(mockReq, { messageId: 'msg123', text: 'Updated text' });
+ await updateMessageText(mockCtx.userId, { messageId: 'msg123', text: 'Updated text' });
// Verify the update
const updatedMessage = await Message.findOne({ messageId: 'msg123', user: 'user123' });
- expect(updatedMessage.text).toBe('Updated text');
+ expect(updatedMessage?.text).toBe('Updated text');
});
});
describe('updateMessage', () => {
it('should update a message for the authenticated user', async () => {
// First save a message
- await saveMessage(mockReq, mockMessageData);
+ await saveMessage(mockCtx, mockMessageData);
- const result = await updateMessage(mockReq, { messageId: 'msg123', text: 'Updated text' });
+ const result = await updateMessage(mockCtx.userId, {
+ messageId: 'msg123',
+ text: 'Updated text',
+ });
- expect(result.messageId).toBe('msg123');
- expect(result.text).toBe('Updated text');
+ expect(result?.messageId).toBe('msg123');
+ expect(result?.text).toBe('Updated text');
// Verify in database
const updatedMessage = await Message.findOne({ messageId: 'msg123', user: 'user123' });
- expect(updatedMessage.text).toBe('Updated text');
+ expect(updatedMessage?.text).toBe('Updated text');
});
it('should throw an error if message is not found', async () => {
await expect(
- updateMessage(mockReq, { messageId: 'nonexistent', text: 'Test' }),
+ updateMessage(mockCtx.userId, { messageId: 'nonexistent', text: 'Test' }),
).rejects.toThrow('Message not found or user not authorized.');
});
});
@@ -125,21 +149,21 @@ describe('Message Operations', () => {
const conversationId = uuidv4();
// Create multiple messages in the same conversation
- await saveMessage(mockReq, {
+ await saveMessage(mockCtx, {
messageId: 'msg1',
conversationId,
text: 'First message',
user: 'user123',
});
- await saveMessage(mockReq, {
+ await saveMessage(mockCtx, {
messageId: 'msg2',
conversationId,
text: 'Second message',
user: 'user123',
});
- await saveMessage(mockReq, {
+ await saveMessage(mockCtx, {
messageId: 'msg3',
conversationId,
text: 'Third message',
@@ -147,7 +171,7 @@ describe('Message Operations', () => {
});
// Delete messages since message2 (this should only delete messages created AFTER msg2)
- await deleteMessagesSince(mockReq, {
+ await deleteMessagesSince(mockCtx.userId, {
messageId: 'msg2',
conversationId,
});
@@ -161,7 +185,7 @@ describe('Message Operations', () => {
});
it('should return undefined if no message is found', async () => {
- const result = await deleteMessagesSince(mockReq, {
+ const result = await deleteMessagesSince(mockCtx.userId, {
messageId: 'nonexistent',
conversationId: 'convo123',
});
@@ -174,14 +198,14 @@ describe('Message Operations', () => {
const conversationId = uuidv4();
// Save some messages
- await saveMessage(mockReq, {
+ await saveMessage(mockCtx, {
messageId: 'msg1',
conversationId,
text: 'First message',
user: 'user123',
});
- await saveMessage(mockReq, {
+ await saveMessage(mockCtx, {
messageId: 'msg2',
conversationId,
text: 'Second message',
@@ -198,9 +222,9 @@ describe('Message Operations', () => {
describe('deleteMessages', () => {
it('should delete messages with the correct filter', async () => {
// Save some messages for different users
- await saveMessage(mockReq, mockMessageData);
+ await saveMessage(mockCtx, mockMessageData);
await saveMessage(
- { user: { id: 'user456' } },
+ { userId: 'user456' },
{
messageId: 'msg456',
conversationId: uuidv4(),
@@ -222,22 +246,23 @@ describe('Message Operations', () => {
describe('Conversation Hijacking Prevention', () => {
it("should not allow editing a message in another user's conversation", async () => {
- const attackerReq = { user: { id: 'attacker123' } };
const victimConversationId = uuidv4();
const victimMessageId = 'victim-msg-123';
// First, save a message as the victim (but we'll try to edit as attacker)
- const victimReq = { user: { id: 'victim123' } };
- await saveMessage(victimReq, {
- messageId: victimMessageId,
- conversationId: victimConversationId,
- text: 'Victim message',
- user: 'victim123',
- });
+ await saveMessage(
+ { userId: 'victim123' },
+ {
+ messageId: victimMessageId,
+ conversationId: victimConversationId,
+ text: 'Victim message',
+ user: 'victim123',
+ },
+ );
// Attacker tries to edit the victim's message
await expect(
- updateMessage(attackerReq, {
+ updateMessage('attacker123', {
messageId: victimMessageId,
conversationId: victimConversationId,
text: 'Hacked message',
@@ -249,25 +274,26 @@ describe('Message Operations', () => {
messageId: victimMessageId,
user: 'victim123',
});
- expect(originalMessage.text).toBe('Victim message');
+ expect(originalMessage?.text).toBe('Victim message');
});
it("should not allow deleting messages from another user's conversation", async () => {
- const attackerReq = { user: { id: 'attacker123' } };
const victimConversationId = uuidv4();
const victimMessageId = 'victim-msg-123';
// Save a message as the victim
- const victimReq = { user: { id: 'victim123' } };
- await saveMessage(victimReq, {
- messageId: victimMessageId,
- conversationId: victimConversationId,
- text: 'Victim message',
- user: 'victim123',
- });
+ await saveMessage(
+ { userId: 'victim123' },
+ {
+ messageId: victimMessageId,
+ conversationId: victimConversationId,
+ text: 'Victim message',
+ user: 'victim123',
+ },
+ );
// Attacker tries to delete from victim's conversation
- const result = await deleteMessagesSince(attackerReq, {
+ const result = await deleteMessagesSince('attacker123', {
messageId: victimMessageId,
conversationId: victimConversationId,
});
@@ -280,41 +306,45 @@ describe('Message Operations', () => {
user: 'victim123',
});
expect(victimMessage).toBeTruthy();
- expect(victimMessage.text).toBe('Victim message');
+ expect(victimMessage?.text).toBe('Victim message');
});
it("should not allow inserting a new message into another user's conversation", async () => {
- const attackerReq = { user: { id: 'attacker123' } };
const victimConversationId = uuidv4();
// Attacker tries to save a message - this should succeed but with attacker's user ID
- const result = await saveMessage(attackerReq, {
- conversationId: victimConversationId,
- text: 'Inserted malicious message',
- messageId: 'new-msg-123',
- user: 'attacker123',
- });
+ const result = await saveMessage(
+ { userId: 'attacker123' },
+ {
+ conversationId: victimConversationId,
+ text: 'Inserted malicious message',
+ messageId: 'new-msg-123',
+ user: 'attacker123',
+ },
+ );
expect(result).toBeTruthy();
- expect(result.user).toBe('attacker123');
+ expect(result?.user).toBe('attacker123');
// Verify the message was saved with the attacker's user ID, not as an anonymous message
const savedMessage = await Message.findOne({ messageId: 'new-msg-123' });
- expect(savedMessage.user).toBe('attacker123');
- expect(savedMessage.conversationId).toBe(victimConversationId);
+ expect(savedMessage?.user).toBe('attacker123');
+ expect(savedMessage?.conversationId).toBe(victimConversationId);
});
it('should allow retrieving messages from any conversation', async () => {
const victimConversationId = uuidv4();
// Save a message in the victim's conversation
- const victimReq = { user: { id: 'victim123' } };
- await saveMessage(victimReq, {
- messageId: 'victim-msg',
- conversationId: victimConversationId,
- text: 'Victim message',
- user: 'victim123',
- });
+ await saveMessage(
+ { userId: 'victim123' },
+ {
+ messageId: 'victim-msg',
+ conversationId: victimConversationId,
+ text: 'Victim message',
+ user: 'victim123',
+ },
+ );
// Anyone should be able to retrieve messages by conversation ID
const messages = await getMessages({ conversationId: victimConversationId });
@@ -331,21 +361,21 @@ describe('Message Operations', () => {
it('should save a message with expiredAt when isTemporary is true', async () => {
// Mock app config with 24 hour retention
- mockReq.config.interfaceConfig.temporaryChatRetention = 24;
+ mockCtx.interfaceConfig = { temporaryChatRetention: 24 };
- mockReq.body = { isTemporary: true };
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveMessage(mockReq, mockMessageData);
+ const result = await saveMessage(mockCtx, mockMessageData);
const afterSave = new Date();
- expect(result.messageId).toBe('msg123');
- expect(result.expiredAt).toBeDefined();
- expect(result.expiredAt).toBeInstanceOf(Date);
+ expect(result?.messageId).toBe('msg123');
+ expect(result?.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeInstanceOf(Date);
// Verify expiredAt is approximately 24 hours in the future
const expectedExpirationTime = new Date(beforeSave.getTime() + 24 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -356,38 +386,37 @@ describe('Message Operations', () => {
});
it('should save a message without expiredAt when isTemporary is false', async () => {
- mockReq.body = { isTemporary: false };
+ mockCtx.isTemporary = false;
- const result = await saveMessage(mockReq, mockMessageData);
+ const result = await saveMessage(mockCtx, mockMessageData);
- expect(result.messageId).toBe('msg123');
- expect(result.expiredAt).toBeNull();
+ expect(result?.messageId).toBe('msg123');
+ expect(result?.expiredAt).toBeNull();
});
it('should save a message without expiredAt when isTemporary is not provided', async () => {
- // No isTemporary in body
- mockReq.body = {};
+ // No isTemporary set
- const result = await saveMessage(mockReq, mockMessageData);
+ const result = await saveMessage(mockCtx, mockMessageData);
- expect(result.messageId).toBe('msg123');
- expect(result.expiredAt).toBeNull();
+ expect(result?.messageId).toBe('msg123');
+ expect(result?.expiredAt).toBeNull();
});
it('should use custom retention period from config', async () => {
// Mock app config with 48 hour retention
- mockReq.config.interfaceConfig.temporaryChatRetention = 48;
+ mockCtx.interfaceConfig = { temporaryChatRetention: 48 };
- mockReq.body = { isTemporary: true };
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveMessage(mockReq, mockMessageData);
+ const result = await saveMessage(mockCtx, mockMessageData);
- expect(result.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeDefined();
// Verify expiredAt is approximately 48 hours in the future
const expectedExpirationTime = new Date(beforeSave.getTime() + 48 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -399,18 +428,18 @@ describe('Message Operations', () => {
it('should handle minimum retention period (1 hour)', async () => {
// Mock app config with less than minimum retention
- mockReq.config.interfaceConfig.temporaryChatRetention = 0.5; // Half hour - should be clamped to 1 hour
+ mockCtx.interfaceConfig = { temporaryChatRetention: 0.5 }; // Half hour - should be clamped to 1 hour
- mockReq.body = { isTemporary: true };
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveMessage(mockReq, mockMessageData);
+ const result = await saveMessage(mockCtx, mockMessageData);
- expect(result.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeDefined();
// Verify expiredAt is approximately 1 hour in the future (minimum)
const expectedExpirationTime = new Date(beforeSave.getTime() + 1 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -422,18 +451,18 @@ describe('Message Operations', () => {
it('should handle maximum retention period (8760 hours)', async () => {
// Mock app config with more than maximum retention
- mockReq.config.interfaceConfig.temporaryChatRetention = 10000; // Should be clamped to 8760 hours
+ mockCtx.interfaceConfig = { temporaryChatRetention: 10000 }; // Should be clamped to 8760 hours
- mockReq.body = { isTemporary: true };
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveMessage(mockReq, mockMessageData);
+ const result = await saveMessage(mockCtx, mockMessageData);
- expect(result.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeDefined();
// Verify expiredAt is approximately 8760 hours (1 year) in the future
const expectedExpirationTime = new Date(beforeSave.getTime() + 8760 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -445,22 +474,22 @@ describe('Message Operations', () => {
it('should handle missing config gracefully', async () => {
// Simulate missing config - should use default retention period
- delete mockReq.config;
+ delete mockCtx.interfaceConfig;
- mockReq.body = { isTemporary: true };
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveMessage(mockReq, mockMessageData);
+ const result = await saveMessage(mockCtx, mockMessageData);
const afterSave = new Date();
// Should still save the message with default retention period (30 days)
- expect(result.messageId).toBe('msg123');
- expect(result.expiredAt).toBeDefined();
- expect(result.expiredAt).toBeInstanceOf(Date);
+ expect(result?.messageId).toBe('msg123');
+ expect(result?.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeInstanceOf(Date);
// Verify expiredAt is approximately 30 days in the future (720 hours)
const expectedExpirationTime = new Date(beforeSave.getTime() + 720 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -472,18 +501,18 @@ describe('Message Operations', () => {
it('should use default retention when config is not provided', async () => {
// Mock getAppConfig to return empty config
- mockReq.config = {}; // Empty config
+ mockCtx.interfaceConfig = undefined; // Empty config
- mockReq.body = { isTemporary: true };
+ mockCtx.isTemporary = true;
const beforeSave = new Date();
- const result = await saveMessage(mockReq, mockMessageData);
+ const result = await saveMessage(mockCtx, mockMessageData);
- expect(result.expiredAt).toBeDefined();
+ expect(result?.expiredAt).toBeDefined();
// Default retention is 30 days (720 hours)
const expectedExpirationTime = new Date(beforeSave.getTime() + 30 * 24 * 60 * 60 * 1000);
- const actualExpirationTime = new Date(result.expiredAt);
+ const actualExpirationTime = new Date(result?.expiredAt ?? 0);
expect(actualExpirationTime.getTime()).toBeGreaterThanOrEqual(
expectedExpirationTime.getTime() - 1000,
@@ -495,47 +524,47 @@ describe('Message Operations', () => {
it('should not update expiredAt on message update', async () => {
// First save a temporary message
- mockReq.config.interfaceConfig.temporaryChatRetention = 24;
+ mockCtx.interfaceConfig = { temporaryChatRetention: 24 };
- mockReq.body = { isTemporary: true };
- const savedMessage = await saveMessage(mockReq, mockMessageData);
- const originalExpiredAt = savedMessage.expiredAt;
+ mockCtx.isTemporary = true;
+ const savedMessage = await saveMessage(mockCtx, mockMessageData);
+ const originalExpiredAt = savedMessage?.expiredAt;
// Now update the message without isTemporary flag
- mockReq.body = {};
- const updatedMessage = await updateMessage(mockReq, {
+ mockCtx.isTemporary = undefined;
+ const updatedMessage = await updateMessage(mockCtx.userId, {
messageId: 'msg123',
text: 'Updated text',
});
// expiredAt should not be in the returned updated message object
- expect(updatedMessage.expiredAt).toBeUndefined();
+ expect(updatedMessage?.expiredAt).toBeUndefined();
// Verify in database that expiredAt wasn't changed
const dbMessage = await Message.findOne({ messageId: 'msg123', user: 'user123' });
- expect(dbMessage.expiredAt).toEqual(originalExpiredAt);
+ expect(dbMessage?.expiredAt).toEqual(originalExpiredAt);
});
it('should preserve expiredAt when saving existing temporary message', async () => {
// First save a temporary message
- mockReq.config.interfaceConfig.temporaryChatRetention = 24;
+ mockCtx.interfaceConfig = { temporaryChatRetention: 24 };
- mockReq.body = { isTemporary: true };
- const firstSave = await saveMessage(mockReq, mockMessageData);
- const originalExpiredAt = firstSave.expiredAt;
+ mockCtx.isTemporary = true;
+ const firstSave = await saveMessage(mockCtx, mockMessageData);
+ const originalExpiredAt = firstSave?.expiredAt;
// Wait a bit to ensure time difference
await new Promise((resolve) => setTimeout(resolve, 100));
// Save again with same messageId but different text
const updatedData = { ...mockMessageData, text: 'Updated text' };
- const secondSave = await saveMessage(mockReq, updatedData);
+ const secondSave = await saveMessage(mockCtx, updatedData);
// Should update text but create new expiredAt
- expect(secondSave.text).toBe('Updated text');
- expect(secondSave.expiredAt).toBeDefined();
- expect(new Date(secondSave.expiredAt).getTime()).toBeGreaterThan(
- new Date(originalExpiredAt).getTime(),
+ expect(secondSave?.text).toBe('Updated text');
+ expect(secondSave?.expiredAt).toBeDefined();
+ expect(new Date(secondSave?.expiredAt ?? 0).getTime()).toBeGreaterThan(
+ new Date(originalExpiredAt ?? 0).getTime(),
);
});
@@ -569,8 +598,8 @@ describe('Message Operations', () => {
const bulk1 = savedMessages.find((m) => m.messageId === 'bulk1');
const bulk2 = savedMessages.find((m) => m.messageId === 'bulk2');
- expect(bulk1.expiredAt).toBeDefined();
- expect(bulk2.expiredAt).toBeNull();
+ expect(bulk1?.expiredAt).toBeDefined();
+ expect(bulk2?.expiredAt).toBeNull();
});
});
@@ -579,7 +608,11 @@ describe('Message Operations', () => {
* Helper to create messages with specific timestamps
* Uses collection.insertOne to bypass Mongoose timestamps
*/
- const createMessageWithTimestamp = async (index, conversationId, createdAt) => {
+ const createMessageWithTimestamp = async (
+ index: number,
+ conversationId: string,
+ createdAt: Date,
+ ) => {
const messageId = uuidv4();
await Message.collection.insertOne({
messageId,
@@ -601,15 +634,22 @@ describe('Message Operations', () => {
conversationId,
user,
pageSize = 25,
- cursor = null,
+ cursor = null as string | null,
sortBy = 'createdAt',
sortDirection = 'desc',
+ }: {
+ conversationId: string;
+ user: string;
+ pageSize?: number;
+ cursor?: string | null;
+ sortBy?: string;
+ sortDirection?: string;
}) => {
const sortOrder = sortDirection === 'asc' ? 1 : -1;
const sortField = ['createdAt', 'updatedAt'].includes(sortBy) ? sortBy : 'createdAt';
const cursorOperator = sortDirection === 'asc' ? '$gt' : '$lt';
- const filter = { conversationId, user };
+ const filter: Record<string, unknown> = { conversationId, user };
if (cursor) {
filter[sortField] = { [cursorOperator]: new Date(cursor) };
}
@@ -619,11 +659,13 @@ describe('Message Operations', () => {
.limit(pageSize + 1)
.lean();
- let nextCursor = null;
+ let nextCursor: string | null = null;
if (messages.length > pageSize) {
messages.pop(); // Remove extra item used to detect next page
// Create cursor from the last RETURNED item (not the popped one)
- nextCursor = messages[messages.length - 1][sortField];
+ nextCursor = (messages[messages.length - 1] as Record<string, unknown>)[
+ sortField
+ ] as string;
}
return { messages, nextCursor };
@@ -677,7 +719,7 @@ describe('Message Operations', () => {
const baseTime = new Date('2026-01-01T12:00:00.000Z');
// Create exactly 26 messages
- const messages = [];
+ const messages: (IMessage | null)[] = [];
for (let i = 0; i < 26; i++) {
const createdAt = new Date(baseTime.getTime() - i * 60000);
const msg = await createMessageWithTimestamp(i, conversationId, createdAt);
@@ -699,7 +741,7 @@ describe('Message Operations', () => {
// Item 26 should NOT be in page 1
const page1Ids = page1.messages.map((m) => m.messageId);
- expect(page1Ids).not.toContain(item26.messageId);
+ expect(page1Ids).not.toContain(item26!.messageId);
// Fetch second page
const page2 = await getMessagesByCursor({
@@ -711,7 +753,7 @@ describe('Message Operations', () => {
// Item 26 MUST be in page 2 (this was the bug - it was being skipped)
expect(page2.messages).toHaveLength(1);
- expect(page2.messages[0].messageId).toBe(item26.messageId);
+ expect((page2.messages[0] as { messageId: string }).messageId).toBe(item26!.messageId);
});
it('should sort by createdAt DESC by default', async () => {
@@ -740,10 +782,10 @@ describe('Message Operations', () => {
});
// Should be sorted by createdAt DESC (newest first) by default
- expect(result.messages).toHaveLength(3);
- expect(result.messages[0].messageId).toBe(msg3.messageId);
- expect(result.messages[1].messageId).toBe(msg2.messageId);
- expect(result.messages[2].messageId).toBe(msg1.messageId);
+ expect(result?.messages).toHaveLength(3);
+ expect((result?.messages[0] as { messageId: string }).messageId).toBe(msg3!.messageId);
+ expect((result?.messages[1] as { messageId: string }).messageId).toBe(msg2!.messageId);
+ expect((result?.messages[2] as { messageId: string }).messageId).toBe(msg1!.messageId);
});
it('should support ascending sort direction', async () => {
@@ -767,9 +809,9 @@ describe('Message Operations', () => {
});
// Should be sorted by createdAt ASC (oldest first)
- expect(result.messages).toHaveLength(2);
- expect(result.messages[0].messageId).toBe(msg1.messageId);
- expect(result.messages[1].messageId).toBe(msg2.messageId);
+ expect(result?.messages).toHaveLength(2);
+ expect((result?.messages[0] as { messageId: string }).messageId).toBe(msg1!.messageId);
+ expect((result?.messages[1] as { messageId: string }).messageId).toBe(msg2!.messageId);
});
it('should handle empty conversation', async () => {
@@ -780,8 +822,8 @@ describe('Message Operations', () => {
user: 'user123',
});
- expect(result.messages).toHaveLength(0);
- expect(result.nextCursor).toBeNull();
+ expect(result?.messages).toHaveLength(0);
+ expect(result?.nextCursor).toBeNull();
});
it('should only return messages for the specified user', async () => {
@@ -814,8 +856,8 @@ describe('Message Operations', () => {
});
// Should only return user123's message
- expect(result.messages).toHaveLength(1);
- expect(result.messages[0].user).toBe('user123');
+ expect(result?.messages).toHaveLength(1);
+ expect((result?.messages[0] as { user: string }).user).toBe('user123');
});
it('should handle exactly pageSize number of messages (no next page)', async () => {
@@ -834,8 +876,8 @@ describe('Message Operations', () => {
pageSize: 25,
});
- expect(result.messages).toHaveLength(25);
- expect(result.nextCursor).toBeNull(); // No next page
+ expect(result?.messages).toHaveLength(25);
+ expect(result?.nextCursor).toBeNull(); // No next page
});
it('should handle pageSize of 1', async () => {
@@ -849,8 +891,8 @@ describe('Message Operations', () => {
}
// Fetch with pageSize 1
- let cursor = null;
- const allMessages = [];
+ let cursor: string | null = null;
+ const allMessages: unknown[] = [];
for (let page = 0; page < 5; page++) {
const result = await getMessagesByCursor({
@@ -860,8 +902,8 @@ describe('Message Operations', () => {
cursor,
});
- allMessages.push(...result.messages);
- cursor = result.nextCursor;
+ allMessages.push(...(result?.messages ?? []));
+ cursor = result?.nextCursor;
if (!cursor) {
break;
@@ -870,7 +912,7 @@ describe('Message Operations', () => {
// Should get all 3 messages without duplicates
expect(allMessages).toHaveLength(3);
- const uniqueIds = new Set(allMessages.map((m) => m.messageId));
+ const uniqueIds = new Set(allMessages.map((m) => (m as { messageId: string }).messageId));
expect(uniqueIds.size).toBe(3);
});
@@ -879,7 +921,7 @@ describe('Message Operations', () => {
const sameTime = new Date('2026-01-01T12:00:00.000Z');
// Create multiple messages with the exact same timestamp
- const messages = [];
+ const messages: (IMessage | null)[] = [];
for (let i = 0; i < 5; i++) {
const msg = await createMessageWithTimestamp(i, conversationId, sameTime);
messages.push(msg);
@@ -892,7 +934,7 @@ describe('Message Operations', () => {
});
// All messages should be returned
- expect(result.messages).toHaveLength(5);
+ expect(result?.messages).toHaveLength(5);
});
});
});
diff --git a/packages/data-schemas/src/methods/message.ts b/packages/data-schemas/src/methods/message.ts
new file mode 100644
index 0000000000..ae5ca72b12
--- /dev/null
+++ b/packages/data-schemas/src/methods/message.ts
@@ -0,0 +1,399 @@
+import type { DeleteResult, FilterQuery, Model } from 'mongoose';
+import logger from '~/config/winston';
+import { createTempChatExpirationDate } from '~/utils/tempChatRetention';
+import type { AppConfig, IMessage } from '~/types';
+
+/** Simple UUID v4 regex to replace zod validation */
+const UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+
+export interface MessageMethods {
+ saveMessage(
+ ctx: { userId: string; isTemporary?: boolean; interfaceConfig?: AppConfig['interfaceConfig'] },
+ params: Partial<IMessage> & { newMessageId?: string },
+ metadata?: { context?: string },
+ ): Promise<IMessage | null | undefined>;
+ bulkSaveMessages(
+ messages: Array<Partial<IMessage>>,
+ overrideTimestamp?: boolean,
+ ): Promise<unknown>;
+ recordMessage(params: {
+ user: string;
+ endpoint?: string;
+ messageId: string;
+ conversationId?: string;
+ parentMessageId?: string;
+ [key: string]: unknown;
+ }): Promise<IMessage | null>;
+ updateMessageText(userId: string, params: { messageId: string; text: string }): Promise<void>;
+ updateMessage(
+ userId: string,
+ message: Partial<IMessage> & { newMessageId?: string },
+ metadata?: { context?: string },
+ ): Promise<Partial<IMessage>>;
+ deleteMessagesSince(
+ userId: string,
+ params: { messageId: string; conversationId: string },
+ ): Promise<DeleteResult>;
+ getMessages(filter: FilterQuery<IMessage>, select?: string): Promise<IMessage[]>;
+ getMessage(params: { user: string; messageId: string }): Promise<IMessage | null>;
+ getMessagesByCursor(
+ filter: FilterQuery<IMessage>,
+ options?: {
+ sortField?: string;
+ sortOrder?: 1 | -1;
+ limit?: number;
+ cursor?: string | null;
+ },
+ ): Promise<{ messages: IMessage[]; nextCursor: string | null }>;
+ searchMessages(
+ query: string,
+ searchOptions: Partial<IMessage>,
+ hydrate?: boolean,
+ ): Promise<unknown>;
+ deleteMessages(filter: FilterQuery<IMessage>): Promise<DeleteResult>;
+}
+
+export function createMessageMethods(mongoose: typeof import('mongoose')): MessageMethods {
+ /**
+ * Saves a message in the database.
+ */
+ async function saveMessage(
+ {
+ userId,
+ isTemporary,
+ interfaceConfig,
+ }: {
+ userId: string;
+ isTemporary?: boolean;
+ interfaceConfig?: AppConfig['interfaceConfig'];
+ },
+ params: Partial<IMessage> & { newMessageId?: string },
+ metadata?: { context?: string },
+ ) {
+ if (!userId) {
+ throw new Error('User not authenticated');
+ }
+
+ const conversationId = params.conversationId as string | undefined;
+ if (!conversationId || !UUID_REGEX.test(conversationId)) {
+ logger.warn(`Invalid conversation ID: ${conversationId}`);
+ logger.info(`---\`saveMessage\` context: ${metadata?.context}`);
+ logger.info(`---Invalid conversation ID Params: ${JSON.stringify(params, null, 2)}`);
+ return;
+ }
+
+ try {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ const update: Record<string, unknown> = {
+ ...params,
+ user: userId,
+ messageId: params.newMessageId || params.messageId,
+ };
+
+ if (isTemporary) {
+ try {
+ update.expiredAt = createTempChatExpirationDate(interfaceConfig);
+ } catch (err) {
+ logger.error('Error creating temporary chat expiration date:', err);
+ logger.info(`---\`saveMessage\` context: ${metadata?.context}`);
+ update.expiredAt = null;
+ }
+ } else {
+ update.expiredAt = null;
+ }
+
+ if (update.tokenCount != null && isNaN(update.tokenCount as number)) {
+ logger.warn(
+ `Resetting invalid \`tokenCount\` for message \`${params.messageId}\`: ${update.tokenCount}`,
+ );
+ logger.info(`---\`saveMessage\` context: ${metadata?.context}`);
+ update.tokenCount = 0;
+ }
+ const message = await Message.findOneAndUpdate(
+ { messageId: params.messageId, user: userId },
+ update,
+ { upsert: true, new: true },
+ );
+
+ return message.toObject();
+ } catch (err: unknown) {
+ logger.error('Error saving message:', err);
+ logger.info(`---\`saveMessage\` context: ${metadata?.context}`);
+
+ const mongoErr = err as { code?: number; message?: string };
+ if (mongoErr.code === 11000 && mongoErr.message?.includes('duplicate key error')) {
+ logger.warn(`Duplicate messageId detected: ${params.messageId}. Continuing execution.`);
+
+ try {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ const existingMessage = await Message.findOne({
+ messageId: params.messageId,
+ user: userId,
+ });
+
+ if (existingMessage) {
+ return existingMessage.toObject();
+ }
+
+ return undefined;
+ } catch (findError) {
+ logger.warn(
+ `Could not retrieve existing message with ID ${params.messageId}: ${(findError as Error).message}`,
+ );
+ return undefined;
+ }
+ }
+
+ throw err;
+ }
+ }
+
+ /**
+ * Saves multiple messages in bulk.
+ */
+ async function bulkSaveMessages(
+ messages: Array<Record<string, unknown>>,
+ overrideTimestamp = false,
+ ) {
+ try {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ const bulkOps = messages.map((message) => ({
+ updateOne: {
+ filter: { messageId: message.messageId },
+ update: message,
+ timestamps: !overrideTimestamp,
+ upsert: true,
+ },
+ }));
+ const result = await Message.bulkWrite(bulkOps);
+ return result;
+ } catch (err) {
+ logger.error('Error saving messages in bulk:', err);
+ throw err;
+ }
+ }
+
+ /**
+ * Records a message in the database (no UUID validation).
+ */
+ async function recordMessage({
+ user,
+ endpoint,
+ messageId,
+ conversationId,
+ parentMessageId,
+ ...rest
+ }: {
+ user: string;
+ endpoint?: string;
+ messageId: string;
+ conversationId?: string;
+ parentMessageId?: string;
+ [key: string]: unknown;
+ }) {
+ try {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ const message = {
+ user,
+ endpoint,
+ messageId,
+ conversationId,
+ parentMessageId,
+ ...rest,
+ };
+
+ return await Message.findOneAndUpdate({ user, messageId }, message, {
+ upsert: true,
+ new: true,
+ });
+ } catch (err) {
+ logger.error('Error recording message:', err);
+ throw err;
+ }
+ }
+
+ /**
+ * Updates the text of a message.
+ */
+ async function updateMessageText(
+ userId: string,
+ { messageId, text }: { messageId: string; text: string },
+ ) {
+ try {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ await Message.updateOne({ messageId, user: userId }, { text });
+ } catch (err) {
+ logger.error('Error updating message text:', err);
+ throw err;
+ }
+ }
+
+ /**
+ * Updates a message and returns sanitized fields.
+ */
+ async function updateMessage(
+ userId: string,
+ message: { messageId: string; [key: string]: unknown },
+ metadata?: { context?: string },
+ ) {
+ try {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ const { messageId, ...update } = message;
+ const updatedMessage = await Message.findOneAndUpdate({ messageId, user: userId }, update, {
+ new: true,
+ });
+
+ if (!updatedMessage) {
+ throw new Error('Message not found or user not authorized.');
+ }
+
+ return {
+ messageId: updatedMessage.messageId,
+ conversationId: updatedMessage.conversationId,
+ parentMessageId: updatedMessage.parentMessageId,
+ sender: updatedMessage.sender,
+ text: updatedMessage.text,
+ isCreatedByUser: updatedMessage.isCreatedByUser,
+ tokenCount: updatedMessage.tokenCount,
+ feedback: updatedMessage.feedback,
+ };
+ } catch (err) {
+ logger.error('Error updating message:', err);
+ if (metadata?.context) {
+ logger.info(`---\`updateMessage\` context: ${metadata.context}`);
+ }
+ throw err;
+ }
+ }
+
+ /**
+ * Deletes messages in a conversation since a specific message.
+ */
+ async function deleteMessagesSince(
+ userId: string,
+ { messageId, conversationId }: { messageId: string; conversationId: string },
+ ) {
+ try {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ const message = await Message.findOne({ messageId, user: userId }).lean();
+
+ if (message) {
+ const query = Message.find({ conversationId, user: userId });
+ return await query.deleteMany({
+ createdAt: { $gt: message.createdAt },
+ });
+ }
+ return undefined;
+ } catch (err) {
+ logger.error('Error deleting messages:', err);
+ throw err;
+ }
+ }
+
+ /**
+ * Retrieves messages from the database.
+ */
+ async function getMessages(filter: FilterQuery<IMessage>, select?: string) {
+ try {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ if (select) {
+ return await Message.find(filter).select(select).sort({ createdAt: 1 }).lean();
+ }
+
+ return await Message.find(filter).sort({ createdAt: 1 }).lean();
+ } catch (err) {
+ logger.error('Error getting messages:', err);
+ throw err;
+ }
+ }
+
+ /**
+ * Retrieves a single message from the database.
+ */
+ async function getMessage({ user, messageId }: { user: string; messageId: string }) {
+ try {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ return await Message.findOne({ user, messageId }).lean();
+ } catch (err) {
+ logger.error('Error getting message:', err);
+ throw err;
+ }
+ }
+
+ /**
+ * Deletes messages from the database.
+ */
+ async function deleteMessages(filter: FilterQuery<IMessage>) {
+ try {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ return await Message.deleteMany(filter);
+ } catch (err) {
+ logger.error('Error deleting messages:', err);
+ throw err;
+ }
+ }
+
+ /**
+ * Retrieves paginated messages with custom sorting and cursor support.
+ */
+ async function getMessagesByCursor(
+ filter: FilterQuery<IMessage>,
+ options: {
+ sortField?: string;
+ sortOrder?: 1 | -1;
+ limit?: number;
+ cursor?: string | null;
+ } = {},
+ ) {
+ const Message = mongoose.models.Message as Model<IMessage>;
+ const { sortField = 'createdAt', sortOrder = -1, limit = 25, cursor } = options;
+ const queryFilter = { ...filter };
+ if (cursor) {
+ queryFilter[sortField] = sortOrder === 1 ? { $gt: cursor } : { $lt: cursor };
+ }
+ const messages = await Message.find(queryFilter)
+ .sort({ [sortField]: sortOrder })
+ .limit(limit + 1)
+ .lean();
+
+ let nextCursor: string | null = null;
+ if (messages.length > limit) {
+ messages.pop();
+ const last = messages[messages.length - 1] as Record<string, unknown>;
+ nextCursor = String(last[sortField] ?? '');
+ }
+ return { messages, nextCursor };
+ }
+
+ /**
+ * Performs a MeiliSearch query on the Message collection.
+ * Requires the meilisearch plugin to be registered on the Message model.
+ */
+ async function searchMessages(
+ query: string,
+ searchOptions: Record<string, unknown>,
+ hydrate?: boolean,
+ ) {
+ const Message = mongoose.models.Message as Model<IMessage> & {
+ meiliSearch?: (q: string, opts: Record<string, unknown>, h?: boolean) => Promise<unknown>;
+ };
+ if (typeof Message.meiliSearch !== 'function') {
+ throw new Error('MeiliSearch plugin not registered on Message model');
+ }
+ return Message.meiliSearch(query, searchOptions, hydrate);
+ }
+
+ return {
+ saveMessage,
+ bulkSaveMessages,
+ recordMessage,
+ updateMessageText,
+ updateMessage,
+ deleteMessagesSince,
+ getMessages,
+ getMessage,
+ getMessagesByCursor,
+ searchMessages,
+ deleteMessages,
+ };
+}
diff --git a/packages/data-schemas/src/methods/preset.ts b/packages/data-schemas/src/methods/preset.ts
new file mode 100644
index 0000000000..11af817cbd
--- /dev/null
+++ b/packages/data-schemas/src/methods/preset.ts
@@ -0,0 +1,132 @@
+import type { Model } from 'mongoose';
+import logger from '~/config/winston';
+
+interface IPreset {
+ user?: string;
+ presetId?: string;
+ order?: number;
+ defaultPreset?: boolean;
+ tools?: (string | { pluginKey?: string })[];
+ updatedAt?: Date;
+ [key: string]: unknown;
+}
+
+export function createPresetMethods(mongoose: typeof import('mongoose')) {
+ /**
+ * Retrieves a single preset by user and presetId.
+ */
+ async function getPreset(user: string, presetId: string) {
+ try {
+ const Preset = mongoose.models.Preset as Model<IPreset>;
+ return await Preset.findOne({ user, presetId }).lean();
+ } catch (error) {
+ logger.error('[getPreset] Error getting single preset', error);
+ return { message: 'Error getting single preset' };
+ }
+ }
+
+ /**
+ * Retrieves all presets for a user, sorted by order then updatedAt.
+ */
+ async function getPresets(user: string, filter: Record<string, unknown> = {}) {
+ try {
+ const Preset = mongoose.models.Preset as Model<IPreset>;
+ const presets = await Preset.find({ ...filter, user }).lean();
+ const defaultValue = 10000;
+
+ presets.sort((a, b) => {
+ const orderA = a.order !== undefined ? a.order : defaultValue;
+ const orderB = b.order !== undefined ? b.order : defaultValue;
+
+ if (orderA !== orderB) {
+ return orderA - orderB;
+ }
+
+ return new Date(b.updatedAt ?? 0).getTime() - new Date(a.updatedAt ?? 0).getTime();
+ });
+
+ return presets;
+ } catch (error) {
+ logger.error('[getPresets] Error getting presets', error);
+ return { message: 'Error retrieving presets' };
+ }
+ }
+
+ /**
+ * Saves a preset. Handles default preset logic and tool normalization.
+ */
+ async function savePreset(
+ user: string,
+ {
+ presetId,
+ newPresetId,
+ defaultPreset,
+ ...preset
+ }: {
+ presetId?: string;
+ newPresetId?: string;
+ defaultPreset?: boolean;
+ [key: string]: unknown;
+ },
+ ) {
+ try {
+ const Preset = mongoose.models.Preset as Model<IPreset>;
+ const setter: Record<string, unknown> = { $set: {} };
+ const { user: _unusedUser, ...cleanPreset } = preset;
+ const update: Record<string, unknown> = { presetId, ...cleanPreset };
+ if (preset.tools && Array.isArray(preset.tools)) {
+ update.tools =
+ (preset.tools as Array<string | { pluginKey?: string }>)
+ .map((tool) => (typeof tool === 'object' && tool?.pluginKey ? tool.pluginKey : tool))
+ .filter((toolName) => typeof toolName === 'string') ?? [];
+ }
+ if (newPresetId) {
+ update.presetId = newPresetId;
+ }
+
+ if (defaultPreset) {
+ update.defaultPreset = defaultPreset;
+ update.order = 0;
+
+ const currentDefault = await Preset.findOne({ defaultPreset: true, user });
+
+ if (currentDefault && currentDefault.presetId !== presetId) {
+ await Preset.findByIdAndUpdate(currentDefault._id, {
+ $unset: { defaultPreset: '', order: '' },
+ });
+ }
+ } else if (defaultPreset === false) {
+ update.defaultPreset = undefined;
+ update.order = undefined;
+ setter['$unset'] = { defaultPreset: '', order: '' };
+ }
+
+ setter.$set = update;
+ return await Preset.findOneAndUpdate({ presetId, user }, setter, {
+ new: true,
+ upsert: true,
+ });
+ } catch (error) {
+ logger.error('[savePreset] Error saving preset', error);
+ return { message: 'Error saving preset' };
+ }
+ }
+
+ /**
+ * Deletes presets matching the given filter for a user.
+ */
+ async function deletePresets(user: string, filter: Record<string, unknown> = {}) {
+ const Preset = mongoose.models.Preset as Model<IPreset>;
+ const deleteCount = await Preset.deleteMany({ ...filter, user });
+ return deleteCount;
+ }
+
+ return {
+ getPreset,
+ getPresets,
+ savePreset,
+ deletePresets,
+ };
+}
+
+export type PresetMethods = ReturnType<typeof createPresetMethods>;
diff --git a/packages/data-schemas/src/methods/prompt.spec.ts b/packages/data-schemas/src/methods/prompt.spec.ts
new file mode 100644
index 0000000000..0a8c2c247e
--- /dev/null
+++ b/packages/data-schemas/src/methods/prompt.spec.ts
@@ -0,0 +1,627 @@
+import mongoose from 'mongoose';
+import { ObjectId } from 'mongodb';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import {
+ SystemRoles,
+ ResourceType,
+ AccessRoleIds,
+ PrincipalType,
+ PermissionBits,
+} from 'librechat-data-provider';
+import type { IPromptGroup, AccessRole as TAccessRole, AclEntry as TAclEntry } from '..';
+import { createAclEntryMethods } from './aclEntry';
+import { logger, createModels } from '..';
+import { createMethods } from './index';
+
+// Disable console for tests
+logger.silent = true;
+
+/** Lean user object from .toObject() */
+type LeanUser = {
+ _id: mongoose.Types.ObjectId | string;
+ name?: string;
+ email: string;
+ role?: string;
+};
+
+/** Lean group object from .toObject() */
+type LeanGroup = {
+ _id: mongoose.Types.ObjectId | string;
+ name: string;
+ description?: string;
+};
+
+/** Lean access role object from .toObject() / .lean() */
+type LeanAccessRole = TAccessRole & { _id: mongoose.Types.ObjectId | string };
+
+/** Lean ACL entry from .lean() */
+type LeanAclEntry = TAclEntry & { _id: mongoose.Types.ObjectId | string };
+
+/** Lean prompt group from .toObject() */
+type LeanPromptGroup = IPromptGroup & { _id: mongoose.Types.ObjectId | string };
+
+let Prompt: mongoose.Model<unknown>;
+let PromptGroup: mongoose.Model<unknown>;
+let AclEntry: mongoose.Model<unknown>;
+let AccessRole: mongoose.Model<unknown>;
+let User: mongoose.Model<unknown>;
+let Group: mongoose.Model<unknown>;
+let methods: ReturnType<typeof createMethods>;
+let aclMethods: ReturnType<typeof createAclEntryMethods>;
+let testUsers: Record<string, LeanUser>;
+let testGroups: Record<string, LeanGroup>;
+let testRoles: Record<string, LeanAccessRole>;
+
+let mongoServer: MongoMemoryServer;
+
+beforeAll(async () => {
+ mongoServer = await MongoMemoryServer.create();
+ const mongoUri = mongoServer.getUri();
+ await mongoose.connect(mongoUri);
+
+ createModels(mongoose);
+ Prompt = mongoose.models.Prompt;
+ PromptGroup = mongoose.models.PromptGroup;
+ AclEntry = mongoose.models.AclEntry;
+ AccessRole = mongoose.models.AccessRole;
+ User = mongoose.models.User;
+ Group = mongoose.models.Group;
+
+ methods = createMethods(mongoose, {
+ removeAllPermissions: async ({ resourceType, resourceId }) => {
+ await AclEntry.deleteMany({ resourceType, resourceId });
+ },
+ });
+ aclMethods = createAclEntryMethods(mongoose);
+
+ await setupTestData();
+});
+
+afterAll(async () => {
+ await mongoose.disconnect();
+ await mongoServer.stop();
+});
+
+async function setupTestData() {
+ testRoles = {
+ viewer: (
+ await AccessRole.create({
+ accessRoleId: AccessRoleIds.PROMPTGROUP_VIEWER,
+ name: 'Viewer',
+ description: 'Can view promptGroups',
+ resourceType: ResourceType.PROMPTGROUP,
+ permBits: PermissionBits.VIEW,
+ })
+ ).toObject() as unknown as LeanAccessRole,
+ editor: (
+ await AccessRole.create({
+ accessRoleId: AccessRoleIds.PROMPTGROUP_EDITOR,
+ name: 'Editor',
+ description: 'Can view and edit promptGroups',
+ resourceType: ResourceType.PROMPTGROUP,
+ permBits: PermissionBits.VIEW | PermissionBits.EDIT,
+ })
+ ).toObject() as unknown as LeanAccessRole,
+ owner: (
+ await AccessRole.create({
+ accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
+ name: 'Owner',
+ description: 'Full control over promptGroups',
+ resourceType: ResourceType.PROMPTGROUP,
+ permBits:
+ PermissionBits.VIEW | PermissionBits.EDIT | PermissionBits.DELETE | PermissionBits.SHARE,
+ })
+ ).toObject() as unknown as LeanAccessRole,
+ };
+
+ testUsers = {
+ owner: (
+ await User.create({
+ name: 'Prompt Owner',
+ email: '[email protected]',
+ role: SystemRoles.USER,
+ })
+ ).toObject() as unknown as LeanUser,
+ editor: (
+ await User.create({
+ name: 'Prompt Editor',
+ email: '[email protected]',
+ role: SystemRoles.USER,
+ })
+ ).toObject() as unknown as LeanUser,
+ viewer: (
+ await User.create({
+ name: 'Prompt Viewer',
+ email: '[email protected]',
+ role: SystemRoles.USER,
+ })
+ ).toObject() as unknown as LeanUser,
+ admin: (
+ await User.create({
+ name: 'Admin User',
+ email: '[email protected]',
+ role: SystemRoles.ADMIN,
+ })
+ ).toObject() as unknown as LeanUser,
+ noAccess: (
+ await User.create({
+ name: 'No Access User',
+ email: '[email protected]',
+ role: SystemRoles.USER,
+ })
+ ).toObject() as unknown as LeanUser,
+ };
+
+ testGroups = {
+ editors: (
+ await Group.create({
+ name: 'Prompt Editors',
+ description: 'Group with editor access',
+ })
+ ).toObject() as unknown as LeanGroup,
+ viewers: (
+ await Group.create({
+ name: 'Prompt Viewers',
+ description: 'Group with viewer access',
+ })
+ ).toObject() as unknown as LeanGroup,
+ };
+}
+
+/** Helper: grant permission via direct AclEntry.create */
+async function grantPermission(params: {
+ principalType: string;
+ principalId: mongoose.Types.ObjectId | string;
+ resourceType: string;
+ resourceId: mongoose.Types.ObjectId | string;
+ accessRoleId: string;
+ grantedBy: mongoose.Types.ObjectId | string;
+}) {
+ const role = (await AccessRole.findOne({
+ accessRoleId: params.accessRoleId,
+ }).lean()) as LeanAccessRole | null;
+ if (!role) {
+ throw new Error(`AccessRole ${params.accessRoleId} not found`);
+ }
+ return aclMethods.grantPermission(
+ params.principalType,
+ params.principalId,
+ params.resourceType,
+ params.resourceId,
+ role.permBits,
+ params.grantedBy,
+ undefined,
+ role._id,
+ );
+}
+
+/** Helper: check permission via getUserPrincipals + hasPermission */
+async function checkPermission(params: {
+ userId: mongoose.Types.ObjectId | string;
+ resourceType: string;
+ resourceId: mongoose.Types.ObjectId | string;
+ requiredPermission: number;
+ includePublic?: boolean;
+}) {
+ // getUserPrincipals already includes user, role, groups, and public
+ const principals = await methods.getUserPrincipals({
+ userId: params.userId,
+ });
+
+ // If not including public, filter it out
+ const filteredPrincipals = params.includePublic
+ ? principals
+ : principals.filter((p) => p.principalType !== PrincipalType.PUBLIC);
+
+ return aclMethods.hasPermission(
+ filteredPrincipals,
+ params.resourceType,
+ params.resourceId,
+ params.requiredPermission,
+ );
+}
+
+describe('Prompt ACL Permissions', () => {
+ describe('Creating Prompts with Permissions', () => {
+ it('should grant owner permissions when creating a prompt', async () => {
+ const testGroup = (
+ await PromptGroup.create({
+ name: 'Test Group',
+ category: 'testing',
+ author: testUsers.owner._id,
+ authorName: testUsers.owner.name,
+ productionId: new mongoose.Types.ObjectId(),
+ })
+ ).toObject() as unknown as LeanPromptGroup;
+
+ const promptData = {
+ prompt: {
+ prompt: 'Test prompt content',
+ name: 'Test Prompt',
+ type: 'text',
+ groupId: testGroup._id,
+ },
+ author: testUsers.owner._id,
+ };
+
+ await methods.savePrompt(promptData);
+
+ // Grant owner permission
+ await grantPermission({
+ principalType: PrincipalType.USER,
+ principalId: testUsers.owner._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testGroup._id,
+ accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
+ grantedBy: testUsers.owner._id,
+ });
+
+ // Check ACL entry
+ const aclEntry = (await AclEntry.findOne({
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testGroup._id,
+ principalType: PrincipalType.USER,
+ principalId: testUsers.owner._id,
+ }).lean()) as LeanAclEntry | null;
+
+ expect(aclEntry).toBeTruthy();
+ expect(aclEntry!.permBits).toBe(testRoles.owner.permBits);
+ });
+ });
+
+ describe('Accessing Prompts', () => {
+ let testPromptGroup: LeanPromptGroup;
+
+ beforeEach(async () => {
+ testPromptGroup = (
+ await PromptGroup.create({
+ name: 'Test Group',
+ author: testUsers.owner._id,
+ authorName: testUsers.owner.name,
+ productionId: new ObjectId(),
+ })
+ ).toObject() as unknown as LeanPromptGroup;
+
+ await Prompt.create({
+ prompt: 'Test prompt for access control',
+ name: 'Access Test Prompt',
+ author: testUsers.owner._id,
+ groupId: testPromptGroup._id,
+ type: 'text',
+ });
+
+ await grantPermission({
+ principalType: PrincipalType.USER,
+ principalId: testUsers.owner._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
+ grantedBy: testUsers.owner._id,
+ });
+ });
+
+ afterEach(async () => {
+ await Prompt.deleteMany({});
+ await PromptGroup.deleteMany({});
+ await AclEntry.deleteMany({});
+ });
+
+ it('owner should have full access to their prompt', async () => {
+ const hasAccess = await checkPermission({
+ userId: testUsers.owner._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ requiredPermission: PermissionBits.VIEW,
+ });
+
+ expect(hasAccess).toBe(true);
+
+ const canEdit = await checkPermission({
+ userId: testUsers.owner._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ requiredPermission: PermissionBits.EDIT,
+ });
+
+ expect(canEdit).toBe(true);
+ });
+
+ it('user with viewer role should only have view access', async () => {
+ await grantPermission({
+ principalType: PrincipalType.USER,
+ principalId: testUsers.viewer._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ accessRoleId: AccessRoleIds.PROMPTGROUP_VIEWER,
+ grantedBy: testUsers.owner._id,
+ });
+
+ const canView = await checkPermission({
+ userId: testUsers.viewer._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ requiredPermission: PermissionBits.VIEW,
+ });
+
+ const canEdit = await checkPermission({
+ userId: testUsers.viewer._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ requiredPermission: PermissionBits.EDIT,
+ });
+
+ expect(canView).toBe(true);
+ expect(canEdit).toBe(false);
+ });
+
+ it('user without permissions should have no access', async () => {
+ const hasAccess = await checkPermission({
+ userId: testUsers.noAccess._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ requiredPermission: PermissionBits.VIEW,
+ });
+
+ expect(hasAccess).toBe(false);
+ });
+
+ it('admin should have access regardless of permissions', async () => {
+ // Admin users should work through normal permission system
+ // The middleware layer handles admin bypass, not the permission service
+ const hasAccess = await checkPermission({
+ userId: testUsers.admin._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ requiredPermission: PermissionBits.VIEW,
+ });
+
+ // Without explicit permissions, even admin won't have access at this layer
+ expect(hasAccess).toBe(false);
+
+ // The actual admin bypass happens in the middleware layer
+ });
+ });
+
+ describe('Group-based Access', () => {
+ afterEach(async () => {
+ await Prompt.deleteMany({});
+ await AclEntry.deleteMany({});
+ await User.updateMany({}, { $set: { groups: [] } });
+ });
+
+ it('group members should inherit group permissions', async () => {
+ const testPromptGroup = (
+ await PromptGroup.create({
+ name: 'Group Test Group',
+ author: testUsers.owner._id,
+ authorName: testUsers.owner.name,
+ productionId: new ObjectId(),
+ })
+ ).toObject() as unknown as LeanPromptGroup;
+
+ // Add user to group
+ await methods.addUserToGroup(testUsers.editor._id, testGroups.editors._id);
+
+ await methods.savePrompt({
+ author: testUsers.owner._id,
+ prompt: {
+ prompt: 'Group test prompt',
+ name: 'Group Test',
+ groupId: testPromptGroup._id,
+ type: 'text',
+ },
+ });
+
+ // Grant edit permissions to the group
+ await grantPermission({
+ principalType: PrincipalType.GROUP,
+ principalId: testGroups.editors._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ accessRoleId: AccessRoleIds.PROMPTGROUP_EDITOR,
+ grantedBy: testUsers.owner._id,
+ });
+
+ // Check if group member has access
+ const hasAccess = await checkPermission({
+ userId: testUsers.editor._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ requiredPermission: PermissionBits.EDIT,
+ });
+
+ expect(hasAccess).toBe(true);
+
+ // Check that non-member doesn't have access
+ const nonMemberAccess = await checkPermission({
+ userId: testUsers.viewer._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ requiredPermission: PermissionBits.EDIT,
+ });
+
+ expect(nonMemberAccess).toBe(false);
+ });
+ });
+
+ describe('Public Access', () => {
+ let publicPromptGroup: LeanPromptGroup;
+ let privatePromptGroup: LeanPromptGroup;
+
+ beforeEach(async () => {
+ publicPromptGroup = (
+ await PromptGroup.create({
+ name: 'Public Access Test Group',
+ author: testUsers.owner._id,
+ authorName: testUsers.owner.name,
+ productionId: new ObjectId(),
+ })
+ ).toObject() as unknown as LeanPromptGroup;
+
+ privatePromptGroup = (
+ await PromptGroup.create({
+ name: 'Private Access Test Group',
+ author: testUsers.owner._id,
+ authorName: testUsers.owner.name,
+ productionId: new ObjectId(),
+ })
+ ).toObject() as unknown as LeanPromptGroup;
+
+ await Prompt.create({
+ prompt: 'Public prompt',
+ name: 'Public',
+ author: testUsers.owner._id,
+ groupId: publicPromptGroup._id,
+ type: 'text',
+ });
+
+ await Prompt.create({
+ prompt: 'Private prompt',
+ name: 'Private',
+ author: testUsers.owner._id,
+ groupId: privatePromptGroup._id,
+ type: 'text',
+ });
+
+ // Grant public view access
+ await aclMethods.grantPermission(
+ PrincipalType.PUBLIC,
+ null,
+ ResourceType.PROMPTGROUP,
+ publicPromptGroup._id,
+ PermissionBits.VIEW,
+ testUsers.owner._id,
+ );
+
+ // Grant only owner access to private
+ await grantPermission({
+ principalType: PrincipalType.USER,
+ principalId: testUsers.owner._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: privatePromptGroup._id,
+ accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
+ grantedBy: testUsers.owner._id,
+ });
+ });
+
+ afterEach(async () => {
+ await Prompt.deleteMany({});
+ await PromptGroup.deleteMany({});
+ await AclEntry.deleteMany({});
+ });
+
+ it('public prompt should be accessible to any user', async () => {
+ const hasAccess = await checkPermission({
+ userId: testUsers.noAccess._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: publicPromptGroup._id,
+ requiredPermission: PermissionBits.VIEW,
+ includePublic: true,
+ });
+
+ expect(hasAccess).toBe(true);
+ });
+
+ it('private prompt should not be accessible to unauthorized users', async () => {
+ const hasAccess = await checkPermission({
+ userId: testUsers.noAccess._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: privatePromptGroup._id,
+ requiredPermission: PermissionBits.VIEW,
+ includePublic: true,
+ });
+
+ expect(hasAccess).toBe(false);
+ });
+ });
+
+ describe('Prompt Deletion', () => {
+ it('should remove ACL entries when prompt is deleted', async () => {
+ const testPromptGroup = (
+ await PromptGroup.create({
+ name: 'Deletion Test Group',
+ author: testUsers.owner._id,
+ authorName: testUsers.owner.name,
+ productionId: new ObjectId(),
+ })
+ ).toObject() as unknown as LeanPromptGroup;
+
+ const result = await methods.savePrompt({
+ author: testUsers.owner._id,
+ prompt: {
+ prompt: 'To be deleted',
+ name: 'Delete Test',
+ groupId: testPromptGroup._id,
+ type: 'text',
+ },
+ });
+
+ const savedPrompt = result as { prompt?: { _id: mongoose.Types.ObjectId } } | null;
+ if (!savedPrompt?.prompt) {
+ throw new Error('Failed to save prompt');
+ }
+ const testPromptId = savedPrompt.prompt._id;
+
+ await grantPermission({
+ principalType: PrincipalType.USER,
+ principalId: testUsers.owner._id,
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ accessRoleId: AccessRoleIds.PROMPTGROUP_OWNER,
+ grantedBy: testUsers.owner._id,
+ });
+
+ // Verify ACL entry exists
+ const beforeDelete = await AclEntry.find({
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ });
+ expect(beforeDelete).toHaveLength(1);
+
+ // Delete the prompt
+ await methods.deletePrompt({
+ promptId: testPromptId,
+ groupId: testPromptGroup._id,
+ author: testUsers.owner._id,
+ role: SystemRoles.USER,
+ });
+
+ // Verify ACL entries are removed
+ const aclEntries = await AclEntry.find({
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: testPromptGroup._id,
+ });
+
+ expect(aclEntries).toHaveLength(0);
+ });
+ });
+
+ describe('Backwards Compatibility', () => {
+ it('should handle prompts without ACL entries gracefully', async () => {
+ const promptGroup = (
+ await PromptGroup.create({
+ name: 'Legacy Test Group',
+ author: testUsers.owner._id,
+ authorName: testUsers.owner.name,
+ productionId: new ObjectId(),
+ })
+ ).toObject() as unknown as LeanPromptGroup;
+
+ const legacyPrompt = (
+ await Prompt.create({
+ prompt: 'Legacy prompt without ACL',
+ name: 'Legacy',
+ author: testUsers.owner._id,
+ groupId: promptGroup._id,
+ type: 'text',
+ })
+ ).toObject() as { _id: mongoose.Types.ObjectId };
+
+ const prompt = (await methods.getPrompt({ _id: legacyPrompt._id })) as {
+ _id: mongoose.Types.ObjectId;
+ } | null;
+ expect(prompt).toBeTruthy();
+ expect(String(prompt!._id)).toBe(String(legacyPrompt._id));
+ });
+ });
+});
diff --git a/packages/data-schemas/src/methods/prompt.ts b/packages/data-schemas/src/methods/prompt.ts
new file mode 100644
index 0000000000..1420495ac2
--- /dev/null
+++ b/packages/data-schemas/src/methods/prompt.ts
@@ -0,0 +1,691 @@
+import type { Model, Types } from 'mongoose';
+import { SystemRoles, ResourceType, SystemCategories } from 'librechat-data-provider';
+import type { IPrompt, IPromptGroup, IPromptGroupDocument } from '~/types';
+import { escapeRegExp } from '~/utils/string';
+import logger from '~/config/winston';
+
+export interface PromptDeps {
+ /** Removes all ACL permissions for a resource. Injected from PermissionService. */
+ removeAllPermissions: (params: { resourceType: string; resourceId: unknown }) => Promise<void>;
+ /** Returns resource IDs solely owned by the given user. From createAclEntryMethods. */
+ getSoleOwnedResourceIds: (
+ userObjectId: Types.ObjectId,
+ resourceTypes: string | string[],
+ ) => Promise<Types.ObjectId[]>;
+}
+
+export function createPromptMethods(mongoose: typeof import('mongoose'), deps: PromptDeps) {
+ const { getSoleOwnedResourceIds } = deps;
+ const { ObjectId } = mongoose.Types;
+
+ /**
+ * Batch-fetches production prompts for an array of prompt groups
+ * and attaches them as `productionPrompt` field.
+ */
+ async function attachProductionPrompts(
+ groups: Array<Record<string, unknown>>,
+ ): Promise<Array<Record<string, unknown>>> {
+ const Prompt = mongoose.models.Prompt as Model<IPrompt>;
+ const uniqueIds = [
+ ...new Set(groups.map((g) => (g.productionId as Types.ObjectId)?.toString()).filter(Boolean)),
+ ];
+ if (uniqueIds.length === 0) {
+ return groups.map((g) => ({ ...g, productionPrompt: null }));
+ }
+
+ const prompts = await Prompt.find({ _id: { $in: uniqueIds } })
+ .select('prompt')
+ .lean();
+ const promptMap = new Map(prompts.map((p) => [p._id.toString(), p]));
+
+ return groups.map((g) => ({
+ ...g,
+ productionPrompt: g.productionId
+ ? (promptMap.get((g.productionId as Types.ObjectId).toString()) ?? null)
+ : null,
+ }));
+ }
+
+ /**
+ * Get all prompt groups with filters (no pagination).
+ */
+ async function getAllPromptGroups(filter: Record<string, unknown>) {
+ try {
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+ const { name, ...query } = filter as {
+ name?: string;
+ category?: string;
+ [key: string]: unknown;
+ };
+
+ if (name) {
+ (query as Record<string, unknown>).name = new RegExp(escapeRegExp(name), 'i');
+ }
+ if (!query.category) {
+ delete query.category;
+ } else if (query.category === SystemCategories.MY_PROMPTS) {
+ delete query.category;
+ } else if (query.category === SystemCategories.NO_CATEGORY) {
+ query.category = '';
+ } else if (query.category === SystemCategories.SHARED_PROMPTS) {
+ delete query.category;
+ }
+
+ const groups = await PromptGroup.find(query)
+ .sort({ createdAt: -1 })
+ .select('name oneliner category author authorName createdAt updatedAt command productionId')
+ .lean();
+ return await attachProductionPrompts(groups as unknown as Array<Record<string, unknown>>);
+ } catch (error) {
+ console.error('Error getting all prompt groups', error);
+ return { message: 'Error getting all prompt groups' };
+ }
+ }
+
+ /**
+ * Get prompt groups with pagination and filters.
+ */
+ async function getPromptGroups(filter: Record<string, unknown>) {
+ try {
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+ const {
+ pageNumber = 1,
+ pageSize = 10,
+ name,
+ ...query
+ } = filter as {
+ pageNumber?: number | string;
+ pageSize?: number | string;
+ name?: string;
+ category?: string;
+ [key: string]: unknown;
+ };
+
+ const validatedPageNumber = Math.max(parseInt(String(pageNumber), 10), 1);
+ const validatedPageSize = Math.max(parseInt(String(pageSize), 10), 1);
+
+ if (name) {
+ (query as Record<string, unknown>).name = new RegExp(escapeRegExp(name), 'i');
+ }
+ if (!query.category) {
+ delete query.category;
+ } else if (query.category === SystemCategories.MY_PROMPTS) {
+ delete query.category;
+ } else if (query.category === SystemCategories.NO_CATEGORY) {
+ query.category = '';
+ } else if (query.category === SystemCategories.SHARED_PROMPTS) {
+ delete query.category;
+ }
+
+ const skip = (validatedPageNumber - 1) * validatedPageSize;
+ const limit = validatedPageSize;
+
+ const [groups, totalPromptGroups] = await Promise.all([
+ PromptGroup.find(query)
+ .sort({ createdAt: -1 })
+ .skip(skip)
+ .limit(limit)
+ .select(
+ 'name numberOfGenerations oneliner category productionId author authorName createdAt updatedAt',
+ )
+ .lean(),
+ PromptGroup.countDocuments(query),
+ ]);
+
+ const promptGroups = await attachProductionPrompts(
+ groups as unknown as Array<Record<string, unknown>>,
+ );
+
+ return {
+ promptGroups,
+ pageNumber: validatedPageNumber.toString(),
+ pageSize: validatedPageSize.toString(),
+ pages: Math.ceil(totalPromptGroups / validatedPageSize).toString(),
+ };
+ } catch (error) {
+ console.error('Error getting prompt groups', error);
+ return { message: 'Error getting prompt groups' };
+ }
+ }
+
+ /**
+ * Delete a prompt group and its prompts, cleaning up ACL permissions.
+ */
+ async function deletePromptGroup({
+ _id,
+ author,
+ role,
+ }: {
+ _id: string;
+ author?: string;
+ role?: string;
+ }) {
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+ const Prompt = mongoose.models.Prompt as Model<IPrompt>;
+
+ const query: Record<string, unknown> = { _id };
+ const groupQuery: Record<string, unknown> = { groupId: new ObjectId(_id) };
+
+ if (author && role !== SystemRoles.ADMIN) {
+ query.author = author;
+ groupQuery.author = author;
+ }
+
+ const response = await PromptGroup.deleteOne(query);
+
+ if (!response || response.deletedCount === 0) {
+ throw new Error('Prompt group not found');
+ }
+
+ await Prompt.deleteMany(groupQuery);
+
+ try {
+ await deps.removeAllPermissions({
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: _id,
+ });
+ } catch (error) {
+ logger.error('Error removing promptGroup permissions:', error);
+ }
+
+ return { message: 'Prompt group deleted successfully' };
+ }
+
+ /**
+ * Get prompt groups by accessible IDs with optional cursor-based pagination.
+ */
+ async function getListPromptGroupsByAccess({
+ accessibleIds = [],
+ otherParams = {},
+ limit = null,
+ after = null,
+ }: {
+ accessibleIds?: Types.ObjectId[];
+ otherParams?: Record<string, unknown>;
+ limit?: number | null;
+ after?: string | null;
+ }) {
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+ const isPaginated = limit !== null && limit !== undefined;
+ const normalizedLimit = isPaginated
+ ? Math.min(Math.max(1, parseInt(String(limit)) || 20), 100)
+ : null;
+
+ const baseQuery: Record<string, unknown> = {
+ ...otherParams,
+ _id: { $in: accessibleIds },
+ };
+
+ if (after && typeof after === 'string' && after !== 'undefined' && after !== 'null') {
+ try {
+ const cursor = JSON.parse(Buffer.from(after, 'base64').toString('utf8'));
+ const { updatedAt, _id } = cursor;
+
+ const cursorCondition = {
+ $or: [
+ { updatedAt: { $lt: new Date(updatedAt) } },
+ { updatedAt: new Date(updatedAt), _id: { $gt: new ObjectId(_id) } },
+ ],
+ };
+
+ if (Object.keys(baseQuery).length > 0) {
+ baseQuery.$and = [{ ...baseQuery }, cursorCondition];
+ Object.keys(baseQuery).forEach((key) => {
+ if (key !== '$and') {
+ delete baseQuery[key];
+ }
+ });
+ } else {
+ Object.assign(baseQuery, cursorCondition);
+ }
+ } catch (error) {
+ logger.warn('Invalid cursor:', (error as Error).message);
+ }
+ }
+
+ const findQuery = PromptGroup.find(baseQuery)
+ .sort({ updatedAt: -1, _id: 1 })
+ .select(
+ 'name numberOfGenerations oneliner category productionId author authorName createdAt updatedAt',
+ );
+
+ if (isPaginated && normalizedLimit) {
+ findQuery.limit(normalizedLimit + 1);
+ }
+
+ const groups = await findQuery.lean();
+ const promptGroups = await attachProductionPrompts(
+ groups as unknown as Array<Record<string, unknown>>,
+ );
+
+ const hasMore = isPaginated && normalizedLimit ? promptGroups.length > normalizedLimit : false;
+ const data = (
+ isPaginated && normalizedLimit ? promptGroups.slice(0, normalizedLimit) : promptGroups
+ ).map((group) => {
+ if (group.author) {
+ group.author = (group.author as Types.ObjectId).toString();
+ }
+ return group;
+ });
+
+ let nextCursor: string | null = null;
+ if (isPaginated && hasMore && data.length > 0 && normalizedLimit) {
+ const lastGroup = promptGroups[normalizedLimit - 1] as Record<string, unknown>;
+ nextCursor = Buffer.from(
+ JSON.stringify({
+ updatedAt: (lastGroup.updatedAt as Date).toISOString(),
+ _id: (lastGroup._id as Types.ObjectId).toString(),
+ }),
+ ).toString('base64');
+ }
+
+ return {
+ object: 'list' as const,
+ data,
+ first_id: data.length > 0 ? (data[0]._id as Types.ObjectId).toString() : null,
+ last_id: data.length > 0 ? (data[data.length - 1]._id as Types.ObjectId).toString() : null,
+ has_more: hasMore,
+ after: nextCursor,
+ };
+ }
+
+ /**
+ * Create a prompt and its respective group.
+ */
+ async function createPromptGroup(saveData: {
+ prompt: Record<string, unknown>;
+ group: Record<string, unknown>;
+ author: string;
+ authorName: string;
+ }) {
+ try {
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+ const Prompt = mongoose.models.Prompt as Model<IPrompt>;
+ const { prompt, group, author, authorName } = saveData;
+
+ let newPromptGroup = await PromptGroup.findOneAndUpdate(
+ { ...group, author, authorName, productionId: null },
+ { $setOnInsert: { ...group, author, authorName, productionId: null } },
+ { new: true, upsert: true },
+ )
+ .lean()
+ .select('-__v')
+ .exec();
+
+ const newPrompt = await Prompt.findOneAndUpdate(
+ { ...prompt, author, groupId: newPromptGroup!._id },
+ { $setOnInsert: { ...prompt, author, groupId: newPromptGroup!._id } },
+ { new: true, upsert: true },
+ )
+ .lean()
+ .select('-__v')
+ .exec();
+
+ newPromptGroup = (await PromptGroup.findByIdAndUpdate(
+ newPromptGroup!._id,
+ { productionId: newPrompt!._id },
+ { new: true },
+ )
+ .lean()
+ .select('-__v')
+ .exec())!;
+
+ return {
+ prompt: newPrompt,
+ group: {
+ ...newPromptGroup,
+ productionPrompt: { prompt: (newPrompt as unknown as IPrompt).prompt },
+ },
+ };
+ } catch (error) {
+ logger.error('Error saving prompt group', error);
+ throw new Error('Error saving prompt group');
+ }
+ }
+
+ /**
+ * Save a prompt.
+ */
+ async function savePrompt(saveData: {
+ prompt: Record<string, unknown>;
+ author: string | Types.ObjectId;
+ }) {
+ try {
+ const Prompt = mongoose.models.Prompt as Model<IPrompt>;
+ const { prompt, author } = saveData;
+ const newPromptData = { ...prompt, author };
+
+ let newPrompt;
+ try {
+ newPrompt = await Prompt.create(newPromptData);
+ } catch (error: unknown) {
+ if ((error as Error)?.message?.includes('groupId_1_version_1')) {
+ await Prompt.db.collection('prompts').dropIndex('groupId_1_version_1');
+ } else {
+ throw error;
+ }
+ newPrompt = await Prompt.create(newPromptData);
+ }
+
+ return { prompt: newPrompt };
+ } catch (error) {
+ logger.error('Error saving prompt', error);
+ return { message: 'Error saving prompt' };
+ }
+ }
+
+ /**
+ * Get prompts by filter.
+ */
+ async function getPrompts(filter: Record<string, unknown>) {
+ try {
+ const Prompt = mongoose.models.Prompt as Model<IPrompt>;
+ return await Prompt.find(filter).sort({ createdAt: -1 }).lean();
+ } catch (error) {
+ logger.error('Error getting prompts', error);
+ return { message: 'Error getting prompts' };
+ }
+ }
+
+ /**
+ * Get a single prompt by filter.
+ */
+ async function getPrompt(filter: Record<string, unknown>) {
+ try {
+ const Prompt = mongoose.models.Prompt as Model<IPrompt>;
+ if (filter.groupId) {
+ filter.groupId = new ObjectId(filter.groupId as string);
+ }
+ return await Prompt.findOne(filter).lean();
+ } catch (error) {
+ logger.error('Error getting prompt', error);
+ return { message: 'Error getting prompt' };
+ }
+ }
+
+ /**
+ * Get random prompt groups from distinct categories.
+ */
+ async function getRandomPromptGroups(filter: { skip: number | string; limit: number | string }) {
+ try {
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+ const categories = await PromptGroup.distinct('category', { category: { $ne: '' } });
+
+ for (let i = categories.length - 1; i > 0; i--) {
+ const j = Math.floor(Math.random() * (i + 1));
+ [categories[i], categories[j]] = [categories[j], categories[i]];
+ }
+
+ const skip = +filter.skip;
+ const limit = +filter.limit;
+ const selectedCategories = categories.slice(skip, skip + limit);
+
+ if (selectedCategories.length === 0) {
+ return { prompts: [] };
+ }
+
+ const groups = await PromptGroup.find({ category: { $in: selectedCategories } }).lean();
+
+ const groupByCategory = new Map<string, unknown>();
+ for (const group of groups) {
+ if (!groupByCategory.has(group.category)) {
+ groupByCategory.set(group.category, group);
+ }
+ }
+
+ const prompts = selectedCategories
+ .map((cat: string) => groupByCategory.get(cat))
+ .filter(Boolean);
+
+ return { prompts };
+ } catch (error) {
+ logger.error('Error getting prompt groups', error);
+ return { message: 'Error getting prompt groups' };
+ }
+ }
+
+ /**
+ * Get prompt groups with populated prompts.
+ */
+ async function getPromptGroupsWithPrompts(filter: Record<string, unknown>) {
+ try {
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+ return await PromptGroup.findOne(filter)
+ .populate({
+ path: 'prompts',
+ select: '-_id -__v -user',
+ })
+ .select('-_id -__v -user')
+ .lean();
+ } catch (error) {
+ logger.error('Error getting prompt groups', error);
+ return { message: 'Error getting prompt groups' };
+ }
+ }
+
+ /**
+ * Get a single prompt group by filter.
+ */
+ async function getPromptGroup(filter: Record<string, unknown>) {
+ try {
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+ return await PromptGroup.findOne(filter).lean();
+ } catch (error) {
+ logger.error('Error getting prompt group', error);
+ return { message: 'Error getting prompt group' };
+ }
+ }
+
+ /**
+ * Delete a prompt, potentially removing the group if it's the last prompt.
+ */
+ async function deletePrompt({
+ promptId,
+ groupId,
+ author,
+ role,
+ }: {
+ promptId: string | Types.ObjectId;
+ groupId: string | Types.ObjectId;
+ author: string | Types.ObjectId;
+ role?: string;
+ }) {
+ const Prompt = mongoose.models.Prompt as Model<IPrompt>;
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+
+ const query: Record<string, unknown> = { _id: promptId, groupId, author };
+ if (role === SystemRoles.ADMIN) {
+ delete query.author;
+ }
+ const { deletedCount } = await Prompt.deleteOne(query);
+ if (deletedCount === 0) {
+ throw new Error('Failed to delete the prompt');
+ }
+
+ const remainingPrompts = await Prompt.find({ groupId })
+ .select('_id')
+ .sort({ createdAt: 1 })
+ .lean();
+
+ if (remainingPrompts.length === 0) {
+ try {
+ await deps.removeAllPermissions({
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: groupId,
+ });
+ } catch (error) {
+ logger.error('Error removing promptGroup permissions:', error);
+ }
+
+ await PromptGroup.deleteOne({ _id: groupId });
+
+ return {
+ prompt: 'Prompt deleted successfully',
+ promptGroup: {
+ message: 'Prompt group deleted successfully',
+ id: groupId,
+ },
+ };
+ } else {
+ const promptGroup = (await PromptGroup.findById(
+ groupId,
+ ).lean()) as unknown as IPromptGroup | null;
+ if (promptGroup && promptGroup.productionId?.toString() === promptId.toString()) {
+ await PromptGroup.updateOne(
+ { _id: groupId },
+ { productionId: remainingPrompts[remainingPrompts.length - 1]._id },
+ );
+ }
+
+ return { prompt: 'Prompt deleted successfully' };
+ }
+ }
+
+ /**
+ * Delete all prompts and prompt groups created by a specific user.
+ */
+ /**
+ * Deletes prompt groups solely owned by the user and cleans up their prompts/ACLs.
+ * Groups with other owners are left intact; the caller is responsible for
+ * removing the user's own ACL principal entries separately.
+ *
+ * Also handles legacy (pre-ACL) prompt groups that only have the author field set,
+ * ensuring they are not orphaned if the permission migration has not been run.
+ */
+ async function deleteUserPrompts(userId: string) {
+ try {
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+ const Prompt = mongoose.models.Prompt as Model<IPrompt>;
+ const AclEntry = mongoose.models.AclEntry;
+
+ const userObjectId = new ObjectId(userId);
+ const soleOwnedIds = await getSoleOwnedResourceIds(userObjectId, ResourceType.PROMPTGROUP);
+
+ const authoredGroups = await PromptGroup.find({ author: userObjectId }).select('_id').lean();
+ const authoredGroupIds = authoredGroups.map((g) => g._id);
+
+ const migratedEntries =
+ authoredGroupIds.length > 0
+ ? await AclEntry.find({
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: { $in: authoredGroupIds },
+ })
+ .select('resourceId')
+ .lean()
+ : [];
+ const migratedIds = new Set(
+ (migratedEntries as Array<{ resourceId: Types.ObjectId }>).map((e) => e.resourceId.toString()),
+ );
+ const legacyGroupIds = authoredGroupIds.filter(
+ (id) => !migratedIds.has(id.toString()),
+ );
+
+ const allGroupIdsToDelete = [...soleOwnedIds, ...legacyGroupIds];
+
+ if (allGroupIdsToDelete.length === 0) {
+ return;
+ }
+
+ await AclEntry.deleteMany({
+ resourceType: ResourceType.PROMPTGROUP,
+ resourceId: { $in: allGroupIdsToDelete },
+ });
+
+ await PromptGroup.deleteMany({ _id: { $in: allGroupIdsToDelete } });
+ await Prompt.deleteMany({ groupId: { $in: allGroupIdsToDelete } });
+ } catch (error) {
+ logger.error('[deleteUserPrompts] General error:', error);
+ }
+ }
+
+ /**
+ * Update a prompt group.
+ */
+ async function updatePromptGroup(filter: Record<string, unknown>, data: Record<string, unknown>) {
+ try {
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+ const updateOps = {};
+ const updateData = { ...data, ...updateOps };
+ const updatedDoc = await PromptGroup.findOneAndUpdate(filter, updateData, {
+ new: true,
+ upsert: false,
+ });
+
+ if (!updatedDoc) {
+ throw new Error('Prompt group not found');
+ }
+
+ return updatedDoc;
+ } catch (error) {
+ logger.error('Error updating prompt group', error);
+ return { message: 'Error updating prompt group' };
+ }
+ }
+
+ /**
+ * Make a prompt the production prompt for its group.
+ */
+ async function makePromptProduction(promptId: string) {
+ try {
+ const Prompt = mongoose.models.Prompt as Model<IPrompt>;
+ const PromptGroup = mongoose.models.PromptGroup as Model<IPromptGroupDocument>;
+
+ const prompt = await Prompt.findById(promptId).lean();
+
+ if (!prompt) {
+ throw new Error('Prompt not found');
+ }
+
+ await PromptGroup.findByIdAndUpdate(
+ prompt.groupId,
+ { productionId: prompt._id },
+ { new: true },
+ )
+ .lean()
+ .exec();
+
+ return { message: 'Prompt production made successfully' };
+ } catch (error) {
+ logger.error('Error making prompt production', error);
+ return { message: 'Error making prompt production' };
+ }
+ }
+
+ /**
+ * Update prompt labels.
+ */
+ async function updatePromptLabels(_id: string, labels: unknown) {
+ try {
+ const Prompt = mongoose.models.Prompt as Model<IPrompt>;
+ const response = await Prompt.updateOne({ _id }, { $set: { labels } });
+ if (response.matchedCount === 0) {
+ return { message: 'Prompt not found' };
+ }
+ return { message: 'Prompt labels updated successfully' };
+ } catch (error) {
+ logger.error('Error updating prompt labels', error);
+ return { message: 'Error updating prompt labels' };
+ }
+ }
+
+ return {
+ getPromptGroups,
+ deletePromptGroup,
+ getAllPromptGroups,
+ getListPromptGroupsByAccess,
+ createPromptGroup,
+ savePrompt,
+ getPrompts,
+ getPrompt,
+ getRandomPromptGroups,
+ getPromptGroupsWithPrompts,
+ getPromptGroup,
+ deletePrompt,
+ deleteUserPrompts,
+ updatePromptGroup,
+ makePromptProduction,
+ updatePromptLabels,
+ };
+}
+
+export type PromptMethods = ReturnType<typeof createPromptMethods>;
diff --git a/api/models/Role.spec.js b/packages/data-schemas/src/methods/role.methods.spec.ts
similarity index 87%
rename from api/models/Role.spec.js
rename to packages/data-schemas/src/methods/role.methods.spec.ts
index 0ec2f831e2..78d7f98ea1 100644
--- a/api/models/Role.spec.js
+++ b/packages/data-schemas/src/methods/role.methods.spec.ts
@@ -1,31 +1,34 @@
-const mongoose = require('mongoose');
-const { MongoMemoryServer } = require('mongodb-memory-server');
-const {
- SystemRoles,
- Permissions,
- roleDefaults,
- PermissionTypes,
-} = require('librechat-data-provider');
-const { getRoleByName, updateAccessPermissions } = require('~/models/Role');
-const getLogStores = require('~/cache/getLogStores');
-const { initializeRoles } = require('~/models');
-const { Role } = require('~/db/models');
-
-// Mock the cache
-jest.mock('~/cache/getLogStores', () =>
- jest.fn().mockReturnValue({
- get: jest.fn(),
- set: jest.fn(),
- del: jest.fn(),
- }),
-);
-
-let mongoServer;
+import mongoose from 'mongoose';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import { SystemRoles, Permissions, roleDefaults, PermissionTypes } from 'librechat-data-provider';
+import type { IRole, RolePermissions } from '..';
+import { createRoleMethods } from './role';
+import { createModels } from '../models';
+
+const mockCache = {
+ get: jest.fn(),
+ set: jest.fn(),
+ del: jest.fn(),
+};
+
+const mockGetCache = jest.fn().mockReturnValue(mockCache);
+
+let Role: mongoose.Model<IRole>;
+let getRoleByName: ReturnType<typeof createRoleMethods>['getRoleByName'];
+let updateAccessPermissions: ReturnType<typeof createRoleMethods>['updateAccessPermissions'];
+let initializeRoles: ReturnType<typeof createRoleMethods>['initializeRoles'];
+let mongoServer: MongoMemoryServer;
beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
const mongoUri = mongoServer.getUri();
await mongoose.connect(mongoUri);
+ createModels(mongoose);
+ Role = mongoose.models.Role;
+ const methods = createRoleMethods(mongoose, { getCache: mockGetCache });
+ getRoleByName = methods.getRoleByName;
+ updateAccessPermissions = methods.updateAccessPermissions;
+ initializeRoles = methods.initializeRoles;
});
afterAll(async () => {
@@ -35,7 +38,10 @@ afterAll(async () => {
beforeEach(async () => {
await Role.deleteMany({});
- getLogStores.mockClear();
+ mockGetCache.mockClear();
+ mockCache.get.mockClear();
+ mockCache.set.mockClear();
+ mockCache.del.mockClear();
});
describe('updateAccessPermissions', () => {
@@ -377,9 +383,9 @@ describe('initializeRoles', () => {
});
// Example: Check default values for ADMIN role
- expect(adminRole.permissions[PermissionTypes.PROMPTS].SHARE).toBe(true);
- expect(adminRole.permissions[PermissionTypes.BOOKMARKS].USE).toBe(true);
- expect(adminRole.permissions[PermissionTypes.AGENTS].CREATE).toBe(true);
+ expect(adminRole.permissions[PermissionTypes.PROMPTS]?.SHARE).toBe(true);
+ expect(adminRole.permissions[PermissionTypes.BOOKMARKS]?.USE).toBe(true);
+ expect(adminRole.permissions[PermissionTypes.AGENTS]?.CREATE).toBe(true);
});
it('should not modify existing permissions for existing roles', async () => {
@@ -424,9 +430,9 @@ describe('initializeRoles', () => {
const userRole = await getRoleByName(SystemRoles.USER);
expect(userRole.permissions[PermissionTypes.AGENTS]).toBeDefined();
- expect(userRole.permissions[PermissionTypes.AGENTS].CREATE).toBeDefined();
- expect(userRole.permissions[PermissionTypes.AGENTS].USE).toBeDefined();
- expect(userRole.permissions[PermissionTypes.AGENTS].SHARE).toBeDefined();
+ expect(userRole.permissions[PermissionTypes.AGENTS]?.CREATE).toBeDefined();
+ expect(userRole.permissions[PermissionTypes.AGENTS]?.USE).toBeDefined();
+ expect(userRole.permissions[PermissionTypes.AGENTS]?.SHARE).toBeDefined();
});
it('should handle multiple runs without duplicating or modifying data', async () => {
@@ -439,8 +445,8 @@ describe('initializeRoles', () => {
expect(adminRoles).toHaveLength(1);
expect(userRoles).toHaveLength(1);
- const adminPerms = adminRoles[0].toObject().permissions;
- const userPerms = userRoles[0].toObject().permissions;
+ const adminPerms = adminRoles[0].toObject().permissions as RolePermissions;
+ const userPerms = userRoles[0].toObject().permissions as RolePermissions;
Object.values(PermissionTypes).forEach((permType) => {
expect(adminPerms[permType]).toBeDefined();
expect(userPerms[permType]).toBeDefined();
@@ -469,9 +475,9 @@ describe('initializeRoles', () => {
partialAdminRole.permissions[PermissionTypes.PROMPTS],
);
expect(adminRole.permissions[PermissionTypes.AGENTS]).toBeDefined();
- expect(adminRole.permissions[PermissionTypes.AGENTS].CREATE).toBeDefined();
- expect(adminRole.permissions[PermissionTypes.AGENTS].USE).toBeDefined();
- expect(adminRole.permissions[PermissionTypes.AGENTS].SHARE).toBeDefined();
+ expect(adminRole.permissions[PermissionTypes.AGENTS]?.CREATE).toBeDefined();
+ expect(adminRole.permissions[PermissionTypes.AGENTS]?.USE).toBeDefined();
+ expect(adminRole.permissions[PermissionTypes.AGENTS]?.SHARE).toBeDefined();
});
it('should include MULTI_CONVO permissions when creating default roles', async () => {
@@ -482,10 +488,10 @@ describe('initializeRoles', () => {
expect(adminRole.permissions[PermissionTypes.MULTI_CONVO]).toBeDefined();
expect(userRole.permissions[PermissionTypes.MULTI_CONVO]).toBeDefined();
- expect(adminRole.permissions[PermissionTypes.MULTI_CONVO].USE).toBe(
+ expect(adminRole.permissions[PermissionTypes.MULTI_CONVO]?.USE).toBe(
roleDefaults[SystemRoles.ADMIN].permissions[PermissionTypes.MULTI_CONVO].USE,
);
- expect(userRole.permissions[PermissionTypes.MULTI_CONVO].USE).toBe(
+ expect(userRole.permissions[PermissionTypes.MULTI_CONVO]?.USE).toBe(
roleDefaults[SystemRoles.USER].permissions[PermissionTypes.MULTI_CONVO].USE,
);
});
@@ -506,6 +512,6 @@ describe('initializeRoles', () => {
const userRole = await getRoleByName(SystemRoles.USER);
expect(userRole.permissions[PermissionTypes.MULTI_CONVO]).toBeDefined();
- expect(userRole.permissions[PermissionTypes.MULTI_CONVO].USE).toBeDefined();
+ expect(userRole.permissions[PermissionTypes.MULTI_CONVO]?.USE).toBeDefined();
});
});
diff --git a/packages/data-schemas/src/methods/role.ts b/packages/data-schemas/src/methods/role.ts
index a12c5fafe5..7b51e45330 100644
--- a/packages/data-schemas/src/methods/role.ts
+++ b/packages/data-schemas/src/methods/role.ts
@@ -1,7 +1,22 @@
-import { roleDefaults, SystemRoles } from 'librechat-data-provider';
+import {
+ CacheKeys,
+ SystemRoles,
+ roleDefaults,
+ permissionsSchema,
+ removeNullishValues,
+} from 'librechat-data-provider';
+import type { IRole } from '~/types';
+import logger from '~/config/winston';
-// Factory function that takes mongoose instance and returns the methods
-export function createRoleMethods(mongoose: typeof import('mongoose')) {
+export interface RoleDeps {
+ /** Returns a cache store for the given key. Injected from getLogStores. */
+ getCache?: (key: string) => {
+ get: (k: string) => Promise<unknown>;
+ set: (k: string, v: unknown) => Promise<void>;
+ };
+}
+
+export function createRoleMethods(mongoose: typeof import('mongoose'), deps: RoleDeps = {}) {
/**
* Initialize default roles in the system.
* Creates the default roles (ADMIN, USER) if they don't exist in the database.
@@ -30,18 +45,310 @@ export function createRoleMethods(mongoose: typeof import('mongoose')) {
}
/**
- * List all roles in the system (for testing purposes)
- * Returns an array of all roles with their names and permissions
+ * List all roles in the system.
*/
async function listRoles() {
const Role = mongoose.models.Role;
return await Role.find({}).select('name permissions').lean();
}
- // Return all methods you want to expose
+ /**
+ * Retrieve a role by name and convert the found role document to a plain object.
+ * If the role with the given name doesn't exist and the name is a system defined role,
+ * create it and return the lean version.
+ */
+ async function getRoleByName(roleName: string, fieldsToSelect: string | string[] | null = null) {
+ const cache = deps.getCache?.(CacheKeys.ROLES);
+ try {
+ if (cache) {
+ const cachedRole = await cache.get(roleName);
+ if (cachedRole) {
+ return cachedRole as IRole;
+ }
+ }
+ const Role = mongoose.models.Role;
+ let query = Role.findOne({ name: roleName });
+ if (fieldsToSelect) {
+ query = query.select(fieldsToSelect);
+ }
+ const role = await query.lean().exec();
+
+ if (!role && SystemRoles[roleName as keyof typeof SystemRoles]) {
+ const newRole = await new Role(roleDefaults[roleName as keyof typeof roleDefaults]).save();
+ if (cache) {
+ await cache.set(roleName, newRole);
+ }
+ return newRole.toObject() as IRole;
+ }
+ if (cache) {
+ await cache.set(roleName, role);
+ }
+ return role as unknown as IRole;
+ } catch (error) {
+ throw new Error(`Failed to retrieve or create role: ${(error as Error).message}`);
+ }
+ }
+
+ /**
+ * Update role values by name.
+ */
+ async function updateRoleByName(roleName: string, updates: Partial<IRole>) {
+ const cache = deps.getCache?.(CacheKeys.ROLES);
+ try {
+ const Role = mongoose.models.Role;
+ const role = await Role.findOneAndUpdate(
+ { name: roleName },
+ { $set: updates },
+ { new: true, lean: true },
+ )
+ .select('-__v')
+ .lean()
+ .exec();
+ if (cache) {
+ await cache.set(roleName, role);
+ }
+ return role as unknown as IRole;
+ } catch (error) {
+ throw new Error(`Failed to update role: ${(error as Error).message}`);
+ }
+ }
+
+ /**
+ * Updates access permissions for a specific role and multiple permission types.
+ */
+ async function updateAccessPermissions(
+ roleName: string,
+ permissionsUpdate: Record<string, Record<string, boolean>>,
+ roleData?: IRole,
+ ) {
+ const updates: Record<string, Record<string, boolean>> = {};
+ for (const [permissionType, permissions] of Object.entries(permissionsUpdate)) {
+ if (
+ permissionsSchema.shape &&
+ permissionsSchema.shape[permissionType as keyof typeof permissionsSchema.shape]
+ ) {
+ updates[permissionType] = removeNullishValues(permissions) as Record<string, boolean>;
+ }
+ }
+ if (!Object.keys(updates).length) {
+ return;
+ }
+
+ try {
+ const role = roleData ?? (await getRoleByName(roleName));
+ if (!role) {
+ return;
+ }
+
+ const currentPermissions =
+ ((role as unknown as Record<string, unknown>).permissions as Record<
+ string,
+ Record<string, boolean>
+ >) || {};
+ const updatedPermissions: Record<string, Record<string, boolean>> = { ...currentPermissions };
+ let hasChanges = false;
+
+ const unsetFields: Record<string, number> = {};
+ const permissionTypes = Object.keys(permissionsSchema.shape || {});
+ for (const permType of permissionTypes) {
+ if (
+ (role as unknown as Record<string, unknown>)[permType] &&
+ typeof (role as unknown as Record<string, unknown>)[permType] === 'object'
+ ) {
+ logger.info(
+ `Migrating '${roleName}' role from old schema: found '${permType}' at top level`,
+ );
+
+ updatedPermissions[permType] = {
+ ...updatedPermissions[permType],
+ ...((role as unknown as Record<string, unknown>)[permType] as Record<string, boolean>),
+ };
+
+ unsetFields[permType] = 1;
+ hasChanges = true;
+ }
+ }
+
+ // Migrate legacy SHARED_GLOBAL → SHARE for PROMPTS and AGENTS.
+ // SHARED_GLOBAL was removed in favour of SHARE in PR #11283. If the DB still has
+ // SHARED_GLOBAL but not SHARE, inherit the value so sharing intent is preserved.
+ const legacySharedGlobalTypes = ['PROMPTS', 'AGENTS'];
+ for (const legacyPermType of legacySharedGlobalTypes) {
+ const existingTypePerms = currentPermissions[legacyPermType];
+ if (
+ existingTypePerms &&
+ 'SHARED_GLOBAL' in existingTypePerms &&
+ !('SHARE' in existingTypePerms) &&
+ updates[legacyPermType] &&
+ // Don't override an explicit SHARE value the caller already provided
+ !('SHARE' in updates[legacyPermType])
+ ) {
+ const inheritedValue = existingTypePerms['SHARED_GLOBAL'];
+ updates[legacyPermType]['SHARE'] = inheritedValue;
+ logger.info(
+ `Migrating '${roleName}' role ${legacyPermType}.SHARED_GLOBAL=${inheritedValue} → SHARE`,
+ );
+ }
+ }
+
+ for (const [permissionType, permissions] of Object.entries(updates)) {
+ const currentTypePermissions = currentPermissions[permissionType] || {};
+ updatedPermissions[permissionType] = { ...currentTypePermissions };
+
+ for (const [permission, value] of Object.entries(permissions)) {
+ if (currentTypePermissions[permission] !== value) {
+ updatedPermissions[permissionType][permission] = value;
+ hasChanges = true;
+ logger.info(
+ `Updating '${roleName}' role permission '${permissionType}' '${permission}' from ${currentTypePermissions[permission]} to: ${value}`,
+ );
+ }
+ }
+ }
+
+ // Clean up orphaned SHARED_GLOBAL fields left in DB after the schema rename.
+ // Since we $set the full permissions object, deleting from updatedPermissions
+ // is sufficient to remove the field from MongoDB.
+ for (const legacyPermType of legacySharedGlobalTypes) {
+ const existingTypePerms = currentPermissions[legacyPermType];
+ if (existingTypePerms && 'SHARED_GLOBAL' in existingTypePerms) {
+ if (!updates[legacyPermType]) {
+ // permType wasn't in the update payload so the migration block above didn't run.
+ // Create a writable copy and handle the SHARED_GLOBAL → SHARE inheritance here
+ // to avoid removing SHARED_GLOBAL without writing SHARE (data loss).
+ updatedPermissions[legacyPermType] = { ...existingTypePerms };
+ if (!('SHARE' in existingTypePerms)) {
+ updatedPermissions[legacyPermType]['SHARE'] = existingTypePerms['SHARED_GLOBAL'];
+ logger.info(
+ `Migrating '${roleName}' role ${legacyPermType}.SHARED_GLOBAL=${existingTypePerms['SHARED_GLOBAL']} → SHARE`,
+ );
+ }
+ }
+ delete updatedPermissions[legacyPermType]['SHARED_GLOBAL'];
+ hasChanges = true;
+ logger.info(
+ `Removed legacy SHARED_GLOBAL field from '${roleName}' role ${legacyPermType} permissions`,
+ );
+ }
+ }
+
+ if (hasChanges) {
+ const Role = mongoose.models.Role;
+ const updateObj = { permissions: updatedPermissions };
+
+ if (Object.keys(unsetFields).length > 0) {
+ logger.info(
+ `Unsetting old schema fields for '${roleName}' role: ${Object.keys(unsetFields).join(', ')}`,
+ );
+
+ try {
+ await Role.updateOne(
+ { name: roleName },
+ {
+ $set: updateObj,
+ $unset: unsetFields,
+ },
+ );
+
+ const cache = deps.getCache?.(CacheKeys.ROLES);
+ const updatedRole = await Role.findOne({ name: roleName }).select('-__v').lean().exec();
+ if (cache) {
+ await cache.set(roleName, updatedRole);
+ }
+
+ logger.info(`Updated role '${roleName}' and removed old schema fields`);
+ } catch (updateError) {
+ logger.error(`Error during role migration update: ${(updateError as Error).message}`);
+ throw updateError;
+ }
+ } else {
+ await updateRoleByName(roleName, updateObj as unknown as Partial<IRole>);
+ }
+
+ logger.info(`Updated '${roleName}' role permissions`);
+ } else {
+ logger.info(`No changes needed for '${roleName}' role permissions`);
+ }
+ } catch (error) {
+ logger.error(`Failed to update ${roleName} role permissions:`, error);
+ }
+ }
+
+ /**
+ * Migrates roles from old schema to new schema structure.
+ */
+ async function migrateRoleSchema(roleName?: string): Promise<number> {
+ try {
+ const Role = mongoose.models.Role;
+ let roles;
+ if (roleName) {
+ const role = await Role.findOne({ name: roleName });
+ roles = role ? [role] : [];
+ } else {
+ roles = await Role.find({});
+ }
+
+ logger.info(`Migrating ${roles.length} roles to new schema structure`);
+ let migratedCount = 0;
+
+ for (const role of roles) {
+ const permissionTypes = Object.keys(permissionsSchema.shape || {});
+ const unsetFields: Record<string, number> = {};
+ let hasOldSchema = false;
+
+ for (const permType of permissionTypes) {
+ if (role[permType] && typeof role[permType] === 'object') {
+ hasOldSchema = true;
+ role.permissions = role.permissions || {};
+ role.permissions[permType] = {
+ ...role.permissions[permType],
+ ...role[permType],
+ };
+ unsetFields[permType] = 1;
+ }
+ }
+
+ if (hasOldSchema) {
+ try {
+ logger.info(`Migrating role '${role.name}' from old schema structure`);
+
+ await Role.updateOne(
+ { _id: role._id },
+ {
+ $set: { permissions: role.permissions },
+ $unset: unsetFields,
+ },
+ );
+
+ const cache = deps.getCache?.(CacheKeys.ROLES);
+ if (cache) {
+ const updatedRole = await Role.findById(role._id).lean().exec();
+ await cache.set(role.name, updatedRole);
+ }
+
+ migratedCount++;
+ logger.info(`Migrated role '${role.name}'`);
+ } catch (error) {
+ logger.error(`Failed to migrate role '${role.name}': ${(error as Error).message}`);
+ }
+ }
+ }
+
+ logger.info(`Migration complete: ${migratedCount} roles migrated`);
+ return migratedCount;
+ } catch (error) {
+ logger.error(`Role schema migration failed: ${(error as Error).message}`);
+ throw error;
+ }
+ }
+
return {
listRoles,
initializeRoles,
+ getRoleByName,
+ updateRoleByName,
+ updateAccessPermissions,
+ migrateRoleSchema,
};
}
diff --git a/api/models/spendTokens.spec.js b/packages/data-schemas/src/methods/spendTokens.spec.ts
similarity index 87%
rename from api/models/spendTokens.spec.js
rename to packages/data-schemas/src/methods/spendTokens.spec.ts
index dfeec5ee83..58e5f4a0ab 100644
--- a/api/models/spendTokens.spec.js
+++ b/packages/data-schemas/src/methods/spendTokens.spec.ts
@@ -1,30 +1,60 @@
-const mongoose = require('mongoose');
-const { MongoMemoryServer } = require('mongodb-memory-server');
-const { createTransaction, createAutoRefillTransaction } = require('./Transaction');
-const { tokenValues, premiumTokenValues, getCacheMultiplier } = require('./tx');
-const { spendTokens, spendStructuredTokens } = require('./spendTokens');
-
-require('~/db/models');
-
-jest.mock('~/config', () => ({
- logger: {
- debug: jest.fn(),
- error: jest.fn(),
- },
+import mongoose from 'mongoose';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import { matchModelName, findMatchingPattern } from './test-helpers';
+import { createModels } from '~/models';
+import { createTxMethods, tokenValues, premiumTokenValues } from './tx';
+import { createTransactionMethods } from './transaction';
+import { createSpendTokensMethods } from './spendTokens';
+import type { ITransaction } from '~/schema/transaction';
+import type { IBalance } from '..';
+
+jest.mock('~/config/winston', () => ({
+ error: jest.fn(),
+ warn: jest.fn(),
+ info: jest.fn(),
+ debug: jest.fn(),
}));
+let mongoServer: InstanceType<typeof MongoMemoryServer>;
+let spendTokens: ReturnType<typeof createSpendTokensMethods>['spendTokens'];
+let spendStructuredTokens: ReturnType<typeof createSpendTokensMethods>['spendStructuredTokens'];
+let createTransaction: ReturnType<typeof createTransactionMethods>['createTransaction'];
+let createAutoRefillTransaction: ReturnType<
+ typeof createTransactionMethods
+>['createAutoRefillTransaction'];
+let getCacheMultiplier: ReturnType<typeof createTxMethods>['getCacheMultiplier'];
+
describe('spendTokens', () => {
- let mongoServer;
- let userId;
- let Transaction;
- let Balance;
+ let userId: mongoose.Types.ObjectId;
+ let Transaction: mongoose.Model<ITransaction>;
+ let Balance: mongoose.Model<IBalance>;
beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
await mongoose.connect(mongoServer.getUri());
- Transaction = mongoose.model('Transaction');
- Balance = mongoose.model('Balance');
+ const models = createModels(mongoose);
+ Object.assign(mongoose.models, models);
+
+ Transaction = mongoose.models.Transaction;
+ Balance = mongoose.models.Balance;
+
+ const txMethods = createTxMethods(mongoose, { matchModelName, findMatchingPattern });
+ getCacheMultiplier = txMethods.getCacheMultiplier;
+
+ const transactionMethods = createTransactionMethods(mongoose, {
+ getMultiplier: txMethods.getMultiplier,
+ getCacheMultiplier: txMethods.getCacheMultiplier,
+ });
+ createTransaction = transactionMethods.createTransaction;
+ createAutoRefillTransaction = transactionMethods.createAutoRefillTransaction;
+
+ const spendMethods = createSpendTokensMethods(mongoose, {
+ createTransaction: transactionMethods.createTransaction,
+ createStructuredTransaction: transactionMethods.createStructuredTransaction,
+ });
+ spendTokens = spendMethods.spendTokens;
+ spendStructuredTokens = spendMethods.spendStructuredTokens;
});
afterAll(async () => {
@@ -79,7 +109,7 @@ describe('spendTokens', () => {
// Verify balance was updated
const balance = await Balance.findOne({ user: userId });
expect(balance).toBeDefined();
- expect(balance.tokenCredits).toBeLessThan(10000); // Balance should be reduced
+ expect(balance!.tokenCredits).toBeLessThan(10000); // Balance should be reduced
});
it('should handle zero completion tokens', async () => {
@@ -111,7 +141,7 @@ describe('spendTokens', () => {
expect(transactions[0].tokenType).toBe('completion');
// In JavaScript -0 and 0 are different but functionally equivalent
// Use Math.abs to handle both 0 and -0
- expect(Math.abs(transactions[0].rawAmount)).toBe(0);
+ expect(Math.abs(transactions[0].rawAmount!)).toBe(0);
// Check prompt transaction
expect(transactions[1].tokenType).toBe('prompt');
@@ -163,7 +193,7 @@ describe('spendTokens', () => {
// Verify balance was not updated (should still be 10000)
const balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBe(10000);
+ expect(balance!.tokenCredits).toBe(10000);
});
it('should not allow balance to go below zero when spending tokens', async () => {
@@ -196,7 +226,7 @@ describe('spendTokens', () => {
// Verify balance was reduced to exactly 0, not negative
const balance = await Balance.findOne({ user: userId });
expect(balance).toBeDefined();
- expect(balance.tokenCredits).toBe(0);
+ expect(balance!.tokenCredits).toBe(0);
// Check that the transaction records show the adjusted values
const transactionResults = await Promise.all(
@@ -244,7 +274,7 @@ describe('spendTokens', () => {
// Check balance after first transaction
let balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBe(0);
+ expect(balance!.tokenCredits).toBe(0);
// Second transaction - should keep balance at 0, not make it negative or increase it
const txData2 = {
@@ -264,7 +294,7 @@ describe('spendTokens', () => {
// Check balance after second transaction - should still be 0
balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBe(0);
+ expect(balance!.tokenCredits).toBe(0);
// Verify all transactions were created
const transactions = await Transaction.find({ user: userId });
@@ -275,7 +305,7 @@ describe('spendTokens', () => {
// Log the transaction details for debugging
console.log('Transaction details:');
- transactionDetails.forEach((tx, i) => {
+ transactionDetails.forEach((tx, i: number) => {
console.log(`Transaction ${i + 1}:`, {
tokenType: tx.tokenType,
rawAmount: tx.rawAmount,
@@ -299,7 +329,7 @@ describe('spendTokens', () => {
console.log('Direct Transaction.create result:', directResult);
// The completion value should never be positive
- expect(directResult.completion).not.toBeGreaterThan(0);
+ expect(directResult!.completion).not.toBeGreaterThan(0);
});
it('should ensure tokenValue is always negative for spending tokens', async () => {
@@ -371,7 +401,7 @@ describe('spendTokens', () => {
// Check balance after first transaction
let balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBe(0);
+ expect(balance!.tokenCredits).toBe(0);
// Second transaction - should keep balance at 0, not make it negative or increase it
const txData2 = {
@@ -395,7 +425,7 @@ describe('spendTokens', () => {
// Check balance after second transaction - should still be 0
balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBe(0);
+ expect(balance!.tokenCredits).toBe(0);
// Verify all transactions were created
const transactions = await Transaction.find({ user: userId });
@@ -406,7 +436,7 @@ describe('spendTokens', () => {
// Log the transaction details for debugging
console.log('Structured transaction details:');
- transactionDetails.forEach((tx, i) => {
+ transactionDetails.forEach((tx, i: number) => {
console.log(`Transaction ${i + 1}:`, {
tokenType: tx.tokenType,
rawAmount: tx.rawAmount,
@@ -453,7 +483,7 @@ describe('spendTokens', () => {
// Verify balance was reduced to exactly 0, not negative
const balance = await Balance.findOne({ user: userId });
expect(balance).toBeDefined();
- expect(balance.tokenCredits).toBe(0);
+ expect(balance!.tokenCredits).toBe(0);
// The result should show the adjusted values
expect(result).toEqual({
@@ -494,7 +524,7 @@ describe('spendTokens', () => {
}));
// Process all transactions concurrently to simulate race conditions
- const promises = [];
+ const promises: Promise<unknown>[] = [];
let expectedTotalSpend = 0;
for (let i = 0; i < collectedUsage.length; i++) {
@@ -567,10 +597,10 @@ describe('spendTokens', () => {
console.log('Initial balance:', initialBalance);
console.log('Expected total spend:', expectedTotalSpend);
console.log('Expected final balance:', expectedFinalBalance);
- console.log('Actual final balance:', finalBalance.tokenCredits);
+ console.log('Actual final balance:', finalBalance!.tokenCredits);
// Allow for small rounding differences
- expect(finalBalance.tokenCredits).toBeCloseTo(expectedFinalBalance, 0);
+ expect(finalBalance!.tokenCredits).toBeCloseTo(expectedFinalBalance, 0);
// Verify all transactions were created
const transactions = await Transaction.find({
@@ -587,19 +617,19 @@ describe('spendTokens', () => {
let totalTokenValue = 0;
transactions.forEach((tx) => {
console.log(`${tx.tokenType}: rawAmount=${tx.rawAmount}, tokenValue=${tx.tokenValue}`);
- totalTokenValue += tx.tokenValue;
+ totalTokenValue += tx.tokenValue!;
});
console.log('Total token value from transactions:', totalTokenValue);
// The difference between expected and actual is significant
// This is likely due to the multipliers being different in the test environment
// Let's adjust our expectation based on the actual transactions
- const actualSpend = initialBalance - finalBalance.tokenCredits;
+ const actualSpend = initialBalance - finalBalance!.tokenCredits;
console.log('Actual spend:', actualSpend);
// Instead of checking the exact balance, let's verify that:
// 1. The balance was reduced (tokens were spent)
- expect(finalBalance.tokenCredits).toBeLessThan(initialBalance);
+ expect(finalBalance!.tokenCredits).toBeLessThan(initialBalance);
// 2. The total token value from transactions matches the actual spend
expect(Math.abs(totalTokenValue)).toBeCloseTo(actualSpend, -3); // Allow for larger differences
});
@@ -616,7 +646,7 @@ describe('spendTokens', () => {
const numberOfRefills = 25;
const refillAmount = 1000;
- const promises = [];
+ const promises: Promise<unknown>[] = [];
for (let i = 0; i < numberOfRefills; i++) {
promises.push(
createAutoRefillTransaction({
@@ -642,10 +672,10 @@ describe('spendTokens', () => {
console.log('Initial balance (Increase Test):', initialBalance);
console.log(`Performed ${numberOfRefills} refills of ${refillAmount} each.`);
console.log('Expected final balance (Increase Test):', expectedFinalBalance);
- console.log('Actual final balance (Increase Test):', finalBalance.tokenCredits);
+ console.log('Actual final balance (Increase Test):', finalBalance!.tokenCredits);
// Use toBeCloseTo for safety, though toBe should work for integer math
- expect(finalBalance.tokenCredits).toBeCloseTo(expectedFinalBalance, 0);
+ expect(finalBalance!.tokenCredits).toBeCloseTo(expectedFinalBalance, 0);
// Verify all transactions were created
const transactions = await Transaction.find({
@@ -657,12 +687,13 @@ describe('spendTokens', () => {
expect(transactions.length).toBe(numberOfRefills);
// Optional: Verify the sum of increments from the results matches the balance change
- const totalIncrementReported = results.reduce((sum, result) => {
+ const totalIncrementReported = results.reduce((sum: number, result) => {
// Assuming createAutoRefillTransaction returns an object with the increment amount
// Adjust this based on the actual return structure.
// Let's assume it returns { balance: newBalance, transaction: { rawAmount: ... } }
// Or perhaps we check the transaction.rawAmount directly
- return sum + (result?.transaction?.rawAmount || 0);
+ const r = result as Record<string, Record<string, unknown>>;
+ return sum + ((r?.transaction?.rawAmount as number) || 0);
}, 0);
console.log('Total increment reported by results:', totalIncrementReported);
expect(totalIncrementReported).toBe(expectedFinalBalance - initialBalance);
@@ -673,7 +704,7 @@ describe('spendTokens', () => {
// For refills, rawAmount is positive, and tokenValue might be calculated based on it
// Let's assume tokenValue directly reflects the increment for simplicity here
// If calculation is involved, adjust accordingly
- totalTokenValueFromDb += tx.rawAmount; // Or tx.tokenValue if that holds the increment
+ totalTokenValueFromDb += tx.rawAmount!; // Or tx.tokenValue if that holds the increment
});
console.log('Total rawAmount from DB transactions:', totalTokenValueFromDb);
expect(totalTokenValueFromDb).toBeCloseTo(expectedFinalBalance - initialBalance, 0);
@@ -733,7 +764,7 @@ describe('spendTokens', () => {
// Verify balance was updated
const balance = await Balance.findOne({ user: userId });
expect(balance).toBeDefined();
- expect(balance.tokenCredits).toBeLessThan(10000); // Balance should be reduced
+ expect(balance!.tokenCredits).toBeLessThan(10000); // Balance should be reduced
});
describe('premium token pricing', () => {
@@ -762,7 +793,7 @@ describe('spendTokens', () => {
promptTokens * tokenValues[model].prompt + completionTokens * tokenValues[model].completion;
const balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
+ expect(balance?.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
});
it('should charge premium rates for claude-opus-4-6 when prompt tokens exceed threshold', async () => {
@@ -791,7 +822,7 @@ describe('spendTokens', () => {
completionTokens * premiumTokenValues[model].completion;
const balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
+ expect(balance?.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
});
it('should charge premium rates for both prompt and completion in structured tokens when above threshold', async () => {
@@ -828,12 +859,12 @@ describe('spendTokens', () => {
const expectedPromptCost =
tokenUsage.promptTokens.input * premiumPromptRate +
- tokenUsage.promptTokens.write * writeRate +
- tokenUsage.promptTokens.read * readRate;
+ tokenUsage.promptTokens.write * (writeRate ?? 0) +
+ tokenUsage.promptTokens.read * (readRate ?? 0);
const expectedCompletionCost = tokenUsage.completionTokens * premiumCompletionRate;
- expect(result.prompt.prompt).toBeCloseTo(-expectedPromptCost, 0);
- expect(result.completion.completion).toBeCloseTo(-expectedCompletionCost, 0);
+ expect(result?.prompt?.prompt).toBeCloseTo(-expectedPromptCost, 0);
+ expect(result?.completion?.completion).toBeCloseTo(-expectedCompletionCost, 0);
});
it('should charge standard rates for structured tokens when below threshold', async () => {
@@ -870,12 +901,12 @@ describe('spendTokens', () => {
const expectedPromptCost =
tokenUsage.promptTokens.input * standardPromptRate +
- tokenUsage.promptTokens.write * writeRate +
- tokenUsage.promptTokens.read * readRate;
+ tokenUsage.promptTokens.write * (writeRate ?? 0) +
+ tokenUsage.promptTokens.read * (readRate ?? 0);
const expectedCompletionCost = tokenUsage.completionTokens * standardCompletionRate;
- expect(result.prompt.prompt).toBeCloseTo(-expectedPromptCost, 0);
- expect(result.completion.completion).toBeCloseTo(-expectedCompletionCost, 0);
+ expect(result?.prompt?.prompt).toBeCloseTo(-expectedPromptCost, 0);
+ expect(result?.completion?.completion).toBeCloseTo(-expectedCompletionCost, 0);
});
it('should charge standard rates for gemini-3.1-pro-preview when prompt tokens are below threshold', async () => {
@@ -1032,7 +1063,7 @@ describe('spendTokens', () => {
promptTokens * tokenValues[model].prompt + completionTokens * tokenValues[model].completion;
const balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
+ expect(balance?.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
});
});
@@ -1058,11 +1089,11 @@ describe('spendTokens', () => {
const completionTx = transactions.find((t) => t.tokenType === 'completion');
const promptTx = transactions.find((t) => t.tokenType === 'prompt');
- expect(Math.abs(promptTx.rawAmount)).toBe(0);
- expect(completionTx.rawAmount).toBe(-100);
+ expect(Math.abs(promptTx?.rawAmount ?? 0)).toBe(0);
+ expect(completionTx?.rawAmount).toBe(-100);
const standardCompletionRate = tokenValues['claude-opus-4-6'].completion;
- expect(completionTx.rate).toBe(standardCompletionRate);
+ expect(completionTx?.rate).toBe(standardCompletionRate);
});
it('should use normalized inputTokenCount for premium threshold check on completion', async () => {
@@ -1092,8 +1123,8 @@ describe('spendTokens', () => {
const premiumPromptRate = premiumTokenValues[model].prompt;
const premiumCompletionRate = premiumTokenValues[model].completion;
- expect(promptTx.rate).toBe(premiumPromptRate);
- expect(completionTx.rate).toBe(premiumCompletionRate);
+ expect(promptTx?.rate).toBe(premiumPromptRate);
+ expect(completionTx?.rate).toBe(premiumCompletionRate);
});
it('should keep inputTokenCount as zero when promptTokens is zero', async () => {
@@ -1116,10 +1147,10 @@ describe('spendTokens', () => {
const completionTx = transactions.find((t) => t.tokenType === 'completion');
const promptTx = transactions.find((t) => t.tokenType === 'prompt');
- expect(Math.abs(promptTx.rawAmount)).toBe(0);
+ expect(Math.abs(promptTx?.rawAmount ?? 0)).toBe(0);
const standardCompletionRate = tokenValues['claude-opus-4-6'].completion;
- expect(completionTx.rate).toBe(standardCompletionRate);
+ expect(completionTx?.rate).toBe(standardCompletionRate);
});
it('should not trigger premium pricing with negative promptTokens on premium model', async () => {
@@ -1144,7 +1175,7 @@ describe('spendTokens', () => {
const completionTx = transactions.find((t) => t.tokenType === 'completion');
const standardCompletionRate = tokenValues[model].completion;
- expect(completionTx.rate).toBe(standardCompletionRate);
+ expect(completionTx?.rate).toBe(standardCompletionRate);
});
it('should normalize negative structured token values to zero in spendStructuredTokens', async () => {
@@ -1178,14 +1209,14 @@ describe('spendTokens', () => {
const completionTx = transactions.find((t) => t.tokenType === 'completion');
const promptTx = transactions.find((t) => t.tokenType === 'prompt');
- expect(Math.abs(promptTx.inputTokens)).toBe(0);
- expect(promptTx.writeTokens).toBe(-50);
- expect(Math.abs(promptTx.readTokens)).toBe(0);
+ expect(Math.abs(promptTx?.inputTokens ?? 0)).toBe(0);
+ expect(promptTx?.writeTokens).toBe(-50);
+ expect(Math.abs(promptTx?.readTokens ?? 0)).toBe(0);
- expect(Math.abs(completionTx.rawAmount)).toBe(0);
+ expect(Math.abs(completionTx?.rawAmount ?? 0)).toBe(0);
const standardRate = tokenValues[model].completion;
- expect(completionTx.rate).toBe(standardRate);
+ expect(completionTx?.rate).toBe(standardRate);
});
});
});
diff --git a/packages/data-schemas/src/methods/spendTokens.ts b/packages/data-schemas/src/methods/spendTokens.ts
new file mode 100644
index 0000000000..4cb6167b55
--- /dev/null
+++ b/packages/data-schemas/src/methods/spendTokens.ts
@@ -0,0 +1,145 @@
+import logger from '~/config/winston';
+import type { TxData, TransactionResult } from './transaction';
+
+/** Base transaction context passed by callers — does not include fields added internally */
+export interface SpendTxData {
+ user: string | import('mongoose').Types.ObjectId;
+ conversationId?: string;
+ model?: string;
+ context?: string;
+ endpointTokenConfig?: Record<string, Record<string, number>> | null;
+ balance?: { enabled?: boolean };
+ transactions?: { enabled?: boolean };
+ valueKey?: string;
+}
+
+export function createSpendTokensMethods(
+ _mongoose: typeof import('mongoose'),
+ transactionMethods: {
+ createTransaction: (txData: TxData) => Promise<TransactionResult | undefined>;
+ createStructuredTransaction: (txData: TxData) => Promise<TransactionResult | undefined>;
+ },
+) {
+ /**
+ * Creates up to two transactions to record the spending of tokens.
+ */
+ async function spendTokens(
+ txData: SpendTxData,
+ tokenUsage: { promptTokens?: number; completionTokens?: number },
+ ) {
+ const { promptTokens, completionTokens } = tokenUsage;
+ logger.debug(
+ `[spendTokens] conversationId: ${txData.conversationId}${
+ txData?.context ? ` | Context: ${txData?.context}` : ''
+ } | Token usage: `,
+ { promptTokens, completionTokens },
+ );
+ let prompt: TransactionResult | undefined, completion: TransactionResult | undefined;
+ const normalizedPromptTokens = Math.max(promptTokens ?? 0, 0);
+ try {
+ if (promptTokens !== undefined) {
+ prompt = await transactionMethods.createTransaction({
+ ...txData,
+ tokenType: 'prompt',
+ rawAmount: promptTokens === 0 ? 0 : -normalizedPromptTokens,
+ inputTokenCount: normalizedPromptTokens,
+ });
+ }
+
+ if (completionTokens !== undefined) {
+ completion = await transactionMethods.createTransaction({
+ ...txData,
+ tokenType: 'completion',
+ rawAmount: completionTokens === 0 ? 0 : -Math.max(completionTokens, 0),
+ inputTokenCount: normalizedPromptTokens,
+ });
+ }
+
+ if (prompt || completion) {
+ logger.debug('[spendTokens] Transaction data record against balance:', {
+ user: txData.user,
+ prompt: prompt?.prompt,
+ promptRate: prompt?.rate,
+ completion: completion?.completion,
+ completionRate: completion?.rate,
+ balance: completion?.balance ?? prompt?.balance,
+ });
+ } else {
+ logger.debug('[spendTokens] No transactions incurred against balance');
+ }
+ } catch (err) {
+ logger.error('[spendTokens]', err);
+ }
+ }
+
+ /**
+ * Creates transactions to record the spending of structured tokens.
+ */
+ async function spendStructuredTokens(
+ txData: SpendTxData,
+ tokenUsage: {
+ promptTokens?: { input?: number; write?: number; read?: number };
+ completionTokens?: number;
+ },
+ ) {
+ const { promptTokens, completionTokens } = tokenUsage;
+ logger.debug(
+ `[spendStructuredTokens] conversationId: ${txData.conversationId}${
+ txData?.context ? ` | Context: ${txData?.context}` : ''
+ } | Token usage: `,
+ { promptTokens, completionTokens },
+ );
+ let prompt: TransactionResult | undefined, completion: TransactionResult | undefined;
+ try {
+ if (promptTokens) {
+ const input = Math.max(promptTokens.input ?? 0, 0);
+ const write = Math.max(promptTokens.write ?? 0, 0);
+ const read = Math.max(promptTokens.read ?? 0, 0);
+ const totalInputTokens = input + write + read;
+ prompt = await transactionMethods.createStructuredTransaction({
+ ...txData,
+ tokenType: 'prompt',
+ inputTokens: -input,
+ writeTokens: -write,
+ readTokens: -read,
+ inputTokenCount: totalInputTokens,
+ });
+ }
+
+ if (completionTokens) {
+ const totalInputTokens = promptTokens
+ ? Math.max(promptTokens.input ?? 0, 0) +
+ Math.max(promptTokens.write ?? 0, 0) +
+ Math.max(promptTokens.read ?? 0, 0)
+ : undefined;
+ completion = await transactionMethods.createTransaction({
+ ...txData,
+ tokenType: 'completion',
+ rawAmount: -Math.max(completionTokens, 0),
+ inputTokenCount: totalInputTokens,
+ });
+ }
+
+ if (prompt || completion) {
+ logger.debug('[spendStructuredTokens] Transaction data record against balance:', {
+ user: txData.user,
+ prompt: prompt?.prompt,
+ promptRate: prompt?.rate,
+ completion: completion?.completion,
+ completionRate: completion?.rate,
+ balance: completion?.balance ?? prompt?.balance,
+ });
+ } else {
+ logger.debug('[spendStructuredTokens] No transactions incurred against balance');
+ }
+ } catch (err) {
+ logger.error('[spendStructuredTokens]', err);
+ }
+
+ return { prompt, completion };
+ }
+
+ return { spendTokens, spendStructuredTokens };
+}
+
+export type SpendTokensMethods = ReturnType<typeof createSpendTokensMethods>;
diff --git a/packages/data-schemas/src/methods/test-helpers.ts b/packages/data-schemas/src/methods/test-helpers.ts
new file mode 100644
index 0000000000..26b5038dd6
--- /dev/null
+++ b/packages/data-schemas/src/methods/test-helpers.ts
@@ -0,0 +1,38 @@
+/**
+ * Inlined utility functions previously imported from @librechat/api.
+ * These are used only by test files in data-schemas.
+ */
+
+/**
+ * Finds the first matching pattern in a tokens/values map by reverse-iterating
+ * and checking if the model name (lowercased) includes the key.
+ *
+ * Inlined from @librechat/api findMatchingPattern
+ */
+export function findMatchingPattern(
+ modelName: string,
+ tokensMap: Record<string, unknown>,
+): string | undefined {
+ const keys = Object.keys(tokensMap);
+ const lowerModelName = modelName.toLowerCase();
+ for (let i = keys.length - 1; i >= 0; i--) {
+ const modelKey = keys[i];
+ if (lowerModelName.includes(modelKey)) {
+ return modelKey;
+ }
+ }
+ return undefined;
+}
+
+/**
+ * Matches a model name to a canonical key. When no maxTokensMap is available
+ * (as in data-schemas tests), returns the model name as-is.
+ *
+ * Inlined from @librechat/api matchModelName (simplified for test use)
+ */
+export function matchModelName(modelName: string, _endpoint?: string): string | undefined {
+ if (typeof modelName !== 'string') {
+ return undefined;
+ }
+ return modelName;
+}
diff --git a/packages/data-schemas/src/methods/toolCall.ts b/packages/data-schemas/src/methods/toolCall.ts
new file mode 100644
index 0000000000..49dfb627e0
--- /dev/null
+++ b/packages/data-schemas/src/methods/toolCall.ts
@@ -0,0 +1,97 @@
+import type { Model } from 'mongoose';
+
+interface IToolCallData {
+ messageId?: string;
+ conversationId?: string;
+ user?: string;
+ [key: string]: unknown;
+}
+
+export function createToolCallMethods(mongoose: typeof import('mongoose')) {
+ /**
+ * Create a new tool call
+ */
+ async function createToolCall(toolCallData: IToolCallData) {
+ try {
+ const ToolCall = mongoose.models.ToolCall as Model<IToolCallData>;
+ return await ToolCall.create(toolCallData);
+ } catch (error) {
+ throw new Error(`Error creating tool call: ${(error as Error).message}`);
+ }
+ }
+
+ /**
+ * Get a tool call by ID
+ */
+ async function getToolCallById(id: string) {
+ try {
+ const ToolCall = mongoose.models.ToolCall as Model<IToolCallData>;
+ return await ToolCall.findById(id).lean();
+ } catch (error) {
+ throw new Error(`Error fetching tool call: ${(error as Error).message}`);
+ }
+ }
+
+ /**
+ * Get tool calls by message ID and user
+ */
+ async function getToolCallsByMessage(messageId: string, userId: string) {
+ try {
+ const ToolCall = mongoose.models.ToolCall as Model<IToolCallData>;
+ return await ToolCall.find({ messageId, user: userId }).lean();
+ } catch (error) {
+ throw new Error(`Error fetching tool calls: ${(error as Error).message}`);
+ }
+ }
+
+ /**
+ * Get tool calls by conversation ID and user
+ */
+ async function getToolCallsByConvo(conversationId: string, userId: string) {
+ try {
+ const ToolCall = mongoose.models.ToolCall as Model<IToolCallData>;
+ return await ToolCall.find({ conversationId, user: userId }).lean();
+ } catch (error) {
+ throw new Error(`Error fetching tool calls: ${(error as Error).message}`);
+ }
+ }
+
+ /**
+ * Update a tool call
+ */
+ async function updateToolCall(id: string, updateData: Partial<IToolCallData>) {
+ try {
+ const ToolCall = mongoose.models.ToolCall as Model<IToolCallData>;
+ return await ToolCall.findByIdAndUpdate(id, updateData, { new: true }).lean();
+ } catch (error) {
+ throw new Error(`Error updating tool call: ${(error as Error).message}`);
+ }
+ }
+
+ /**
+ * Delete tool calls by user and optionally conversation
+ */
+ async function deleteToolCalls(userId: string, conversationId?: string) {
+ try {
+ const ToolCall = mongoose.models.ToolCall as Model<IToolCallData>;
+ const query: Record<string, string> = { user: userId };
+ if (conversationId) {
+ query.conversationId = conversationId;
+ }
+ return await ToolCall.deleteMany(query);
+ } catch (error) {
+ throw new Error(`Error deleting tool call: ${(error as Error).message}`);
+ }
+ }
+
+ return {
+ createToolCall,
+ updateToolCall,
+ deleteToolCalls,
+ getToolCallById,
+ getToolCallsByConvo,
+ getToolCallsByMessage,
+ };
+}
+
+export type ToolCallMethods = ReturnType<typeof createToolCallMethods>;
diff --git a/api/models/Transaction.spec.js b/packages/data-schemas/src/methods/transaction.spec.ts
similarity index 89%
rename from api/models/Transaction.spec.js
rename to packages/data-schemas/src/methods/transaction.spec.ts
index f363c472e1..feaf9b758f 100644
--- a/api/models/Transaction.spec.js
+++ b/packages/data-schemas/src/methods/transaction.spec.ts
@@ -1,16 +1,63 @@
-const mongoose = require('mongoose');
-const { recordCollectedUsage } = require('@librechat/api');
-const { createMethods } = require('@librechat/data-schemas');
-const { MongoMemoryServer } = require('mongodb-memory-server');
-const { getMultiplier, getCacheMultiplier, premiumTokenValues, tokenValues } = require('./tx');
-const { createTransaction, createStructuredTransaction } = require('./Transaction');
-const { spendTokens, spendStructuredTokens } = require('./spendTokens');
-const { Balance, Transaction } = require('~/db/models');
-
-let mongoServer;
+import mongoose from 'mongoose';
+import { MongoMemoryServer } from 'mongodb-memory-server';
+import type { ITransaction } from '~/schema/transaction';
+import type { TxData } from './transaction';
+import type { IBalance } from '..';
+import { createTxMethods, tokenValues, premiumTokenValues } from './tx';
+import { matchModelName, findMatchingPattern } from './test-helpers';
+import { createSpendTokensMethods } from './spendTokens';
+import { createTransactionMethods } from './transaction';
+import { createModels } from '~/models';
+
+jest.mock('~/config/winston', () => ({
+ error: jest.fn(),
+ warn: jest.fn(),
+ info: jest.fn(),
+ debug: jest.fn(),
+}));
+
+let mongoServer: InstanceType<typeof MongoMemoryServer>;
+let Balance: mongoose.Model<IBalance>;
+let Transaction: mongoose.Model<ITransaction>;
+let spendTokens: ReturnType<typeof createSpendTokensMethods>['spendTokens'];
+let spendStructuredTokens: ReturnType<typeof createSpendTokensMethods>['spendStructuredTokens'];
+let createTransaction: ReturnType<typeof createTransactionMethods>['createTransaction'];
+let createStructuredTransaction: ReturnType<
+ typeof createTransactionMethods
+>['createStructuredTransaction'];
+let getMultiplier: ReturnType<typeof createTxMethods>['getMultiplier'];
+let getCacheMultiplier: ReturnType<typeof createTxMethods>['getCacheMultiplier'];
+
beforeAll(async () => {
mongoServer = await MongoMemoryServer.create();
const mongoUri = mongoServer.getUri();
+
+ // Register models
+ const models = createModels(mongoose);
+ Object.assign(mongoose.models, models);
+
+ Balance = mongoose.models.Balance;
+ Transaction = mongoose.models.Transaction;
+
+ // Create methods from factories (following the chain in methods/index.ts)
+ const txMethods = createTxMethods(mongoose, { matchModelName, findMatchingPattern });
+ getMultiplier = txMethods.getMultiplier;
+ getCacheMultiplier = txMethods.getCacheMultiplier;
+
+ const transactionMethods = createTransactionMethods(mongoose, {
+ getMultiplier: txMethods.getMultiplier,
+ getCacheMultiplier: txMethods.getCacheMultiplier,
+ });
+ createTransaction = transactionMethods.createTransaction;
+ createStructuredTransaction = transactionMethods.createStructuredTransaction;
+
+ const spendMethods = createSpendTokensMethods(mongoose, {
+ createTransaction: transactionMethods.createTransaction,
+ createStructuredTransaction: transactionMethods.createStructuredTransaction,
+ });
+ spendTokens = spendMethods.spendTokens;
+ spendStructuredTokens = spendMethods.spendStructuredTokens;
+
await mongoose.connect(mongoUri);
});
@@ -55,7 +102,7 @@ describe('Regular Token Spending Tests', () => {
const expectedTotalCost = 100 * promptMultiplier + 50 * completionMultiplier;
const expectedBalance = initialBalance - expectedTotalCost;
- expect(updatedBalance.tokenCredits).toBeCloseTo(expectedBalance, 0);
+ expect(updatedBalance?.tokenCredits).toBeCloseTo(expectedBalance, 0);
});
test('spendTokens should handle zero completion tokens', async () => {
@@ -86,7 +133,7 @@ describe('Regular Token Spending Tests', () => {
const updatedBalance = await Balance.findOne({ user: userId });
const promptMultiplier = getMultiplier({ model, tokenType: 'prompt' });
const expectedCost = 100 * promptMultiplier;
- expect(updatedBalance.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
+ expect(updatedBalance?.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
});
test('spendTokens should handle undefined token counts', async () => {
@@ -139,7 +186,7 @@ describe('Regular Token Spending Tests', () => {
const updatedBalance = await Balance.findOne({ user: userId });
const promptMultiplier = getMultiplier({ model, tokenType: 'prompt' });
const expectedCost = 100 * promptMultiplier;
- expect(updatedBalance.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
+ expect(updatedBalance?.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
});
test('spendTokens should not update balance when balance feature is disabled', async () => {
@@ -168,7 +215,7 @@ describe('Regular Token Spending Tests', () => {
// Assert: Balance should remain unchanged.
const updatedBalance = await Balance.findOne({ user: userId });
- expect(updatedBalance.tokenCredits).toBe(initialBalance);
+ expect(updatedBalance?.tokenCredits).toBe(initialBalance);
});
});
@@ -209,23 +256,25 @@ describe('Structured Token Spending Tests', () => {
// Calculate expected costs.
const expectedPromptCost =
tokenUsage.promptTokens.input * promptMultiplier +
- tokenUsage.promptTokens.write * writeMultiplier +
- tokenUsage.promptTokens.read * readMultiplier;
+ tokenUsage.promptTokens.write * (writeMultiplier ?? 0) +
+ tokenUsage.promptTokens.read * (readMultiplier ?? 0);
const expectedCompletionCost = tokenUsage.completionTokens * completionMultiplier;
const expectedTotalCost = expectedPromptCost + expectedCompletionCost;
const expectedBalance = initialBalance - expectedTotalCost;
// Assert
- expect(result.completion.balance).toBeLessThan(initialBalance);
+ expect(result?.completion?.balance).toBeLessThan(initialBalance);
const allowedDifference = 100;
- expect(Math.abs(result.completion.balance - expectedBalance)).toBeLessThan(allowedDifference);
- const balanceDecrease = initialBalance - result.completion.balance;
+ expect(Math.abs((result?.completion?.balance ?? 0) - expectedBalance)).toBeLessThan(
+ allowedDifference,
+ );
+ const balanceDecrease = initialBalance - (result?.completion?.balance ?? 0);
expect(balanceDecrease).toBeCloseTo(expectedTotalCost, 0);
const expectedPromptTokenValue = -expectedPromptCost;
const expectedCompletionTokenValue = -expectedCompletionCost;
- expect(result.prompt.prompt).toBeCloseTo(expectedPromptTokenValue, 1);
- expect(result.completion.completion).toBe(expectedCompletionTokenValue);
+ expect(result?.prompt?.prompt).toBeCloseTo(expectedPromptTokenValue, 1);
+ expect(result?.completion?.completion).toBe(expectedCompletionTokenValue);
});
test('should handle zero completion tokens in structured spending', async () => {
@@ -258,7 +307,7 @@ describe('Structured Token Spending Tests', () => {
// Assert
expect(result.prompt).toBeDefined();
expect(result.completion).toBeUndefined();
- expect(result.prompt.prompt).toBeLessThan(0);
+ expect(result?.prompt?.prompt).toBeLessThan(0);
});
test('should handle only prompt tokens in structured spending', async () => {
@@ -290,7 +339,7 @@ describe('Structured Token Spending Tests', () => {
// Assert
expect(result.prompt).toBeDefined();
expect(result.completion).toBeUndefined();
- expect(result.prompt.prompt).toBeLessThan(0);
+ expect(result?.prompt?.prompt).toBeLessThan(0);
});
test('should handle undefined token counts in structured spending', async () => {
@@ -349,7 +398,7 @@ describe('Structured Token Spending Tests', () => {
// Assert:
// (Assuming a multiplier for completion of 15 and a cancel rate of 1.15 as noted in the original test.)
- expect(result.completion.completion).toBeCloseTo(-50 * 15 * 1.15, 0);
+ expect(result?.completion?.completion).toBeCloseTo(-50 * 15 * 1.15, 0);
});
});
@@ -361,7 +410,7 @@ describe('NaN Handling Tests', () => {
await Balance.create({ user: userId, tokenCredits: initialBalance });
const model = 'gpt-3.5-turbo';
- const txData = {
+ const txData: TxData = {
user: userId,
conversationId: 'test-conversation-id',
model,
@@ -378,7 +427,7 @@ describe('NaN Handling Tests', () => {
// Assert: No transaction should be created and balance remains unchanged.
expect(result).toBeUndefined();
const balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBe(initialBalance);
+ expect(balance?.tokenCredits).toBe(initialBalance);
});
});
@@ -390,7 +439,7 @@ describe('Transactions Config Tests', () => {
await Balance.create({ user: userId, tokenCredits: initialBalance });
const model = 'gpt-3.5-turbo';
- const txData = {
+ const txData: TxData = {
user: userId,
conversationId: 'test-conversation-id',
model,
@@ -409,7 +458,7 @@ describe('Transactions Config Tests', () => {
const transactions = await Transaction.find({ user: userId });
expect(transactions).toHaveLength(0);
const balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBe(initialBalance);
+ expect(balance?.tokenCredits).toBe(initialBalance);
});
test('createTransaction should save when transactions.enabled is true', async () => {
@@ -419,7 +468,7 @@ describe('Transactions Config Tests', () => {
await Balance.create({ user: userId, tokenCredits: initialBalance });
const model = 'gpt-3.5-turbo';
- const txData = {
+ const txData: TxData = {
user: userId,
conversationId: 'test-conversation-id',
model,
@@ -436,7 +485,7 @@ describe('Transactions Config Tests', () => {
// Assert: Transaction should be created
expect(result).toBeDefined();
- expect(result.balance).toBeLessThan(initialBalance);
+ expect(result?.balance).toBeLessThan(initialBalance);
const transactions = await Transaction.find({ user: userId });
expect(transactions).toHaveLength(1);
expect(transactions[0].rawAmount).toBe(-100);
@@ -449,7 +498,7 @@ describe('Transactions Config Tests', () => {
await Balance.create({ user: userId, tokenCredits: initialBalance });
const model = 'gpt-3.5-turbo';
- const txData = {
+ const txData: TxData = {
user: userId,
conversationId: 'test-conversation-id',
model,
@@ -466,7 +515,7 @@ describe('Transactions Config Tests', () => {
// Assert: Transaction should be created (backward compatibility)
expect(result).toBeDefined();
- expect(result.balance).toBeLessThan(initialBalance);
+ expect(result?.balance).toBeLessThan(initialBalance);
const transactions = await Transaction.find({ user: userId });
expect(transactions).toHaveLength(1);
});
@@ -478,7 +527,7 @@ describe('Transactions Config Tests', () => {
await Balance.create({ user: userId, tokenCredits: initialBalance });
const model = 'gpt-3.5-turbo';
- const txData = {
+ const txData: TxData = {
user: userId,
conversationId: 'test-conversation-id',
model,
@@ -499,7 +548,7 @@ describe('Transactions Config Tests', () => {
expect(transactions).toHaveLength(1);
expect(transactions[0].rawAmount).toBe(-100);
const balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBe(initialBalance);
+ expect(balance?.tokenCredits).toBe(initialBalance);
});
test('createStructuredTransaction should not save when transactions.enabled is false', async () => {
@@ -509,7 +558,7 @@ describe('Transactions Config Tests', () => {
await Balance.create({ user: userId, tokenCredits: initialBalance });
const model = 'claude-3-5-sonnet';
- const txData = {
+ const txData: TxData = {
user: userId,
conversationId: 'test-conversation-id',
model,
@@ -529,7 +578,7 @@ describe('Transactions Config Tests', () => {
const transactions = await Transaction.find({ user: userId });
expect(transactions).toHaveLength(0);
const balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBe(initialBalance);
+ expect(balance?.tokenCredits).toBe(initialBalance);
});
test('createStructuredTransaction should save transaction but not update balance when balance is disabled but transactions enabled', async () => {
@@ -539,7 +588,7 @@ describe('Transactions Config Tests', () => {
await Balance.create({ user: userId, tokenCredits: initialBalance });
const model = 'claude-3-5-sonnet';
- const txData = {
+ const txData: TxData = {
user: userId,
conversationId: 'test-conversation-id',
model,
@@ -563,7 +612,7 @@ describe('Transactions Config Tests', () => {
expect(transactions[0].writeTokens).toBe(-100);
expect(transactions[0].readTokens).toBe(-5);
const balance = await Balance.findOne({ user: userId });
- expect(balance.tokenCredits).toBe(initialBalance);
+ expect(balance?.tokenCredits).toBe(initialBalance);
});
});
@@ -587,11 +636,11 @@ describe('calculateTokenValue Edge Cases', () => {
});
const expectedRate = getMultiplier({ model, tokenType: 'prompt' });
- expect(result.rate).toBe(expectedRate);
+ expect(result?.rate).toBe(expectedRate);
const tx = await Transaction.findOne({ user: userId });
- expect(tx.tokenValue).toBe(-promptTokens * expectedRate);
- expect(tx.rate).toBe(expectedRate);
+ expect(tx?.tokenValue).toBe(-promptTokens * expectedRate);
+ expect(tx?.rate).toBe(expectedRate);
});
test('should derive valueKey and apply correct rate for an unknown model with tokenType', async () => {
@@ -610,9 +659,9 @@ describe('calculateTokenValue Edge Cases', () => {
});
const tx = await Transaction.findOne({ user: userId });
- expect(tx.rate).toBeDefined();
- expect(tx.rate).toBeGreaterThan(0);
- expect(tx.tokenValue).toBe(tx.rawAmount * tx.rate);
+ expect(tx?.rate).toBeDefined();
+ expect(tx?.rate).toBeGreaterThan(0);
+ expect(tx?.tokenValue).toBe((tx?.rawAmount ?? 0) * (tx?.rate ?? 0));
});
test('should correctly apply model-derived multiplier without valueKey for completion', async () => {
@@ -635,10 +684,10 @@ describe('calculateTokenValue Edge Cases', () => {
const expectedRate = getMultiplier({ model, tokenType: 'completion' });
expect(expectedRate).toBe(tokenValues[model].completion);
- expect(result.rate).toBe(expectedRate);
+ expect(result?.rate).toBe(expectedRate);
const updatedBalance = await Balance.findOne({ user: userId });
- expect(updatedBalance.tokenCredits).toBeCloseTo(
+ expect(updatedBalance?.tokenCredits).toBeCloseTo(
initialBalance - completionTokens * expectedRate,
0,
);
@@ -672,7 +721,7 @@ describe('Premium Token Pricing Integration Tests', () => {
promptTokens * standardPromptRate + completionTokens * standardCompletionRate;
const updatedBalance = await Balance.findOne({ user: userId });
- expect(updatedBalance.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
+ expect(updatedBalance?.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
});
test('spendTokens should apply premium pricing when prompt tokens exceed premium threshold', async () => {
@@ -701,7 +750,7 @@ describe('Premium Token Pricing Integration Tests', () => {
promptTokens * premiumPromptRate + completionTokens * premiumCompletionRate;
const updatedBalance = await Balance.findOne({ user: userId });
- expect(updatedBalance.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
+ expect(updatedBalance?.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
});
test('spendTokens should apply standard pricing at exactly the premium threshold', async () => {
@@ -730,7 +779,7 @@ describe('Premium Token Pricing Integration Tests', () => {
promptTokens * standardPromptRate + completionTokens * standardCompletionRate;
const updatedBalance = await Balance.findOne({ user: userId });
- expect(updatedBalance.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
+ expect(updatedBalance?.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
});
test('spendStructuredTokens should apply premium pricing when total input tokens exceed threshold', async () => {
@@ -769,14 +818,14 @@ describe('Premium Token Pricing Integration Tests', () => {
const expectedPromptCost =
tokenUsage.promptTokens.input * premiumPromptRate +
- tokenUsage.promptTokens.write * writeMultiplier +
- tokenUsage.promptTokens.read * readMultiplier;
+ tokenUsage.promptTokens.write * (writeMultiplier ?? 0) +
+ tokenUsage.promptTokens.read * (readMultiplier ?? 0);
const expectedCompletionCost = tokenUsage.completionTokens * premiumCompletionRate;
const expectedTotalCost = expectedPromptCost + expectedCompletionCost;
const updatedBalance = await Balance.findOne({ user: userId });
expect(totalInput).toBeGreaterThan(premiumTokenValues[model].threshold);
- expect(updatedBalance.tokenCredits).toBeCloseTo(initialBalance - expectedTotalCost, 0);
+ expect(updatedBalance?.tokenCredits).toBeCloseTo(initialBalance - expectedTotalCost, 0);
});
test('spendStructuredTokens should apply standard pricing when total input tokens are below threshold', async () => {
@@ -815,14 +864,14 @@ describe('Premium Token Pricing Integration Tests', () => {
const expectedPromptCost =
tokenUsage.promptTokens.input * standardPromptRate +
- tokenUsage.promptTokens.write * writeMultiplier +
- tokenUsage.promptTokens.read * readMultiplier;
+ tokenUsage.promptTokens.write * (writeMultiplier ?? 0) +
+ tokenUsage.promptTokens.read * (readMultiplier ?? 0);
const expectedCompletionCost = tokenUsage.completionTokens * standardCompletionRate;
const expectedTotalCost = expectedPromptCost + expectedCompletionCost;
const updatedBalance = await Balance.findOne({ user: userId });
expect(totalInput).toBeLessThanOrEqual(premiumTokenValues[model].threshold);
- expect(updatedBalance.tokenCredits).toBeCloseTo(initialBalance - expectedTotalCost, 0);
+ expect(updatedBalance?.tokenCredits).toBeCloseTo(initialBalance - expectedTotalCost, 0);
});
test('spendTokens should apply standard pricing for gemini-3.1-pro-preview below threshold', async () => {
@@ -984,7 +1033,7 @@ describe('Premium Token Pricing Integration Tests', () => {
promptTokens * standardPromptRate + completionTokens * standardCompletionRate;
const updatedBalance = await Balance.findOne({ user: userId });
- expect(updatedBalance.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
+ expect(updatedBalance?.tokenCredits).toBeCloseTo(initialBalance - expectedCost, 0);
});
});
diff --git a/packages/data-schemas/src/methods/transaction.ts b/packages/data-schemas/src/methods/transaction.ts
index d521b9e85e..3f019defa2 100644
--- a/packages/data-schemas/src/methods/transaction.ts
+++ b/packages/data-schemas/src/methods/transaction.ts
@@ -1,24 +1,199 @@
-import type { IBalance, TransactionData } from '~/types';
import logger from '~/config/winston';
+import type { FilterQuery, Model, Types } from 'mongoose';
+import type { ITransaction } from '~/schema/transaction';
+import type { IBalance, IBalanceUpdate } from '~/types';
-interface UpdateBalanceParams {
+const cancelRate = 1.15;
+
+type MultiplierParams = {
+ model?: string;
+ valueKey?: string;
+ tokenType?: 'prompt' | 'completion';
+ inputTokenCount?: number;
+ endpointTokenConfig?: Record<string, Record<string, number>>;
+};
+
+type CacheMultiplierParams = {
+ cacheType?: 'write' | 'read';
+ model?: string;
+ endpointTokenConfig?: Record<string, Record<string, number>>;
+};
+
+/** Fields read/written by the internal token value calculators */
+interface InternalTxDoc {
+ valueKey?: string;
+ tokenType?: 'prompt' | 'completion' | 'credits';
+ model?: string;
+ endpointTokenConfig?: Record<string, Record<string, number>> | null;
+ inputTokenCount?: number;
+ rawAmount?: number;
+ context?: string;
+ rate?: number;
+ tokenValue?: number;
+ rateDetail?: Record<string, number>;
+ inputTokens?: number;
+ writeTokens?: number;
+ readTokens?: number;
+}
+
+/** Input data for creating a transaction */
+export interface TxData {
+ user: string | Types.ObjectId;
+ conversationId?: string;
+ model?: string;
+ context?: string;
+ tokenType?: 'prompt' | 'completion' | 'credits';
+ rawAmount?: number;
+ valueKey?: string;
+ endpointTokenConfig?: Record<string, Record<string, number>> | null;
+ inputTokenCount?: number;
+ inputTokens?: number;
+ writeTokens?: number;
+ readTokens?: number;
+ balance?: { enabled?: boolean };
+ transactions?: { enabled?: boolean };
+}
+
+/** Return value from a successful transaction that also updates the balance */
+export interface TransactionResult {
+ rate: number;
user: string;
- incrementValue: number;
- setValues?: Partial<Pick<IBalance, 'tokenCredits' | 'lastRefill'>>;
+ balance: number;
+ prompt?: number;
+ completion?: number;
+ credits?: number;
}
-export function createTransactionMethods(mongoose: typeof import('mongoose')) {
- async function updateBalance({ user, incrementValue, setValues }: UpdateBalanceParams) {
+export function createTransactionMethods(
+ mongoose: typeof import('mongoose'),
+ txMethods: {
+ getMultiplier: (params: MultiplierParams) => number;
+ getCacheMultiplier: (params: CacheMultiplierParams) => number | null;
+ },
+) {
+ /** Calculate and set the tokenValue for a transaction */
+ function calculateTokenValue(txn: InternalTxDoc) {
+ const { valueKey, tokenType, model, endpointTokenConfig, inputTokenCount } = txn;
+ const multiplier = Math.abs(
+ txMethods.getMultiplier({
+ valueKey,
+ tokenType: tokenType as 'prompt' | 'completion' | undefined,
+ model,
+ endpointTokenConfig: endpointTokenConfig ?? undefined,
+ inputTokenCount,
+ }),
+ );
+ txn.rate = multiplier;
+ txn.tokenValue = (txn.rawAmount ?? 0) * multiplier;
+ if (txn.context && txn.tokenType === 'completion' && txn.context === 'incomplete') {
+ txn.tokenValue = Math.ceil((txn.tokenValue ?? 0) * cancelRate);
+ txn.rate = (txn.rate ?? 0) * cancelRate;
+ }
+ }
+
+ /** Calculate token value for structured tokens */
+ function calculateStructuredTokenValue(txn: InternalTxDoc) {
+ if (!txn.tokenType) {
+ txn.tokenValue = txn.rawAmount;
+ return;
+ }
+
+ const { model, endpointTokenConfig, inputTokenCount } = txn;
+ const etConfig = endpointTokenConfig ?? undefined;
+
+ if (txn.tokenType === 'prompt') {
+ const inputMultiplier = txMethods.getMultiplier({
+ tokenType: 'prompt',
+ model,
+ endpointTokenConfig: etConfig,
+ inputTokenCount,
+ });
+ const writeMultiplier =
+ txMethods.getCacheMultiplier({
+ cacheType: 'write',
+ model,
+ endpointTokenConfig: etConfig,
+ }) ?? inputMultiplier;
+ const readMultiplier =
+ txMethods.getCacheMultiplier({ cacheType: 'read', model, endpointTokenConfig: etConfig }) ??
+ inputMultiplier;
+
+ txn.rateDetail = {
+ input: inputMultiplier,
+ write: writeMultiplier,
+ read: readMultiplier,
+ };
+
+ const totalPromptTokens =
+ Math.abs(txn.inputTokens ?? 0) +
+ Math.abs(txn.writeTokens ?? 0) +
+ Math.abs(txn.readTokens ?? 0);
+
+ if (totalPromptTokens > 0) {
+ txn.rate =
+ (Math.abs(inputMultiplier * (txn.inputTokens ?? 0)) +
+ Math.abs(writeMultiplier * (txn.writeTokens ?? 0)) +
+ Math.abs(readMultiplier * (txn.readTokens ?? 0))) /
+ totalPromptTokens;
+ } else {
+ txn.rate = Math.abs(inputMultiplier);
+ }
+
+ txn.tokenValue = -(
+ Math.abs(txn.inputTokens ?? 0) * inputMultiplier +
+ Math.abs(txn.writeTokens ?? 0) * writeMultiplier +
+ Math.abs(txn.readTokens ?? 0) * readMultiplier
+ );
+
+ txn.rawAmount = -totalPromptTokens;
+ } else if (txn.tokenType === 'completion') {
+ const multiplier = txMethods.getMultiplier({
+ tokenType: txn.tokenType,
+ model,
+ endpointTokenConfig: etConfig,
+ inputTokenCount,
+ });
+ txn.rate = Math.abs(multiplier);
+ txn.tokenValue = -Math.abs(txn.rawAmount ?? 0) * multiplier;
+ txn.rawAmount = -Math.abs(txn.rawAmount ?? 0);
+ }
+
+ if (txn.context && txn.tokenType === 'completion' && txn.context === 'incomplete') {
+ txn.tokenValue = Math.ceil((txn.tokenValue ?? 0) * cancelRate);
+ txn.rate = (txn.rate ?? 0) * cancelRate;
+ if (txn.rateDetail) {
+ txn.rateDetail = Object.fromEntries(
+ Object.entries(txn.rateDetail).map(([k, v]) => [k, v * cancelRate]),
+ );
+ }
+ }
+ }
+
+ /**
+ * Updates a user's token balance using optimistic concurrency control.
+ * Always returns an IBalance or throws after exhausting retries.
+ */
+ async function updateBalance({
+ user,
+ incrementValue,
+ setValues,
+ }: {
+ user: string;
+ incrementValue: number;
+ setValues?: IBalanceUpdate;
+ }): Promise<IBalance> {
+ const Balance = mongoose.models.Balance as Model<IBalance>;
const maxRetries = 10;
let delay = 50;
let lastError: Error | null = null;
- const Balance = mongoose.models.Balance;
for (let attempt = 1; attempt <= maxRetries; attempt++) {
+ let currentBalanceDoc;
try {
- const currentBalanceDoc = await Balance.findOne({ user }).lean<IBalance>();
- const currentCredits = currentBalanceDoc?.tokenCredits ?? 0;
- const newCredits = Math.max(0, currentCredits + incrementValue);
+ currentBalanceDoc = await Balance.findOne({ user }).lean();
+ const currentCredits = currentBalanceDoc ? currentBalanceDoc.tokenCredits : 0;
+ const potentialNewCredits = currentCredits + incrementValue;
+ const newCredits = Math.max(0, potentialNewCredits);
const updatePayload = {
$set: {
@@ -27,8 +202,9 @@ export function createTransactionMethods(mongoose: typeof import('mongoose')) {
},
};
+ let updatedBalance: IBalance | null = null;
if (currentBalanceDoc) {
- const updatedBalance = await Balance.findOneAndUpdate(
+ updatedBalance = await Balance.findOneAndUpdate(
{ user, tokenCredits: currentCredits },
updatePayload,
{ new: true },
@@ -40,7 +216,7 @@ export function createTransactionMethods(mongoose: typeof import('mongoose')) {
lastError = new Error(`Concurrency conflict for user ${user} on attempt ${attempt}.`);
} else {
try {
- const updatedBalance = await Balance.findOneAndUpdate({ user }, updatePayload, {
+ updatedBalance = await Balance.findOneAndUpdate({ user }, updatePayload, {
upsert: true,
new: true,
}).lean();
@@ -86,15 +262,162 @@ export function createTransactionMethods(mongoose: typeof import('mongoose')) {
);
}
- /** Bypasses document middleware; all computed fields must be pre-calculated before calling. */
- async function bulkInsertTransactions(docs: TransactionData[]): Promise<void> {
+ /**
+ * Creates an auto-refill transaction that also updates balance.
+ */
+ async function createAutoRefillTransaction(txData: TxData) {
+ if (txData.rawAmount != null && isNaN(txData.rawAmount)) {
+ return;
+ }
+ const Transaction = mongoose.models.Transaction;
+ const transaction = new Transaction(txData);
+ transaction.endpointTokenConfig = txData.endpointTokenConfig;
+ transaction.inputTokenCount = txData.inputTokenCount;
+ calculateTokenValue(transaction);
+ await transaction.save();
+
+ const balanceResponse = await updateBalance({
+ user: transaction.user as string,
+ incrementValue: txData.rawAmount ?? 0,
+ setValues: { lastRefill: new Date() },
+ });
+ const result = {
+ rate: transaction.rate as number,
+ user: transaction.user.toString() as string,
+ balance: balanceResponse.tokenCredits,
+ transaction,
+ };
+ logger.debug('[Balance.check] Auto-refill performed', result);
+ return result;
+ }
+
+ /**
+ * Creates a transaction and updates the balance.
+ */
+ async function createTransaction(_txData: TxData): Promise<TransactionResult | undefined> {
+ const { balance, transactions, ...txData } = _txData;
+ if (txData.rawAmount != null && isNaN(txData.rawAmount)) {
+ return;
+ }
+
+ if (transactions?.enabled === false) {
+ return;
+ }
+
+ const Transaction = mongoose.models.Transaction;
+ const transaction = new Transaction(txData);
+ transaction.endpointTokenConfig = txData.endpointTokenConfig;
+ transaction.inputTokenCount = txData.inputTokenCount;
+ calculateTokenValue(transaction);
+
+ await transaction.save();
+ if (!balance?.enabled) {
+ return;
+ }
+
+ const incrementValue = transaction.tokenValue as number;
+ const balanceResponse = await updateBalance({
+ user: transaction.user as string,
+ incrementValue,
+ });
+
+ return {
+ rate: transaction.rate as number,
+ user: transaction.user.toString() as string,
+ balance: balanceResponse.tokenCredits,
+ [transaction.tokenType as string]: incrementValue,
+ } as TransactionResult;
+ }
+
+ /**
+ * Creates a structured transaction and updates the balance.
+ */
+ async function createStructuredTransaction(
+ _txData: TxData,
+ ): Promise<TransactionResult | undefined> {
+ const { balance, transactions, ...txData } = _txData;
+ if (transactions?.enabled === false) {
+ return;
+ }
+
const Transaction = mongoose.models.Transaction;
- if (docs.length) {
- await Transaction.insertMany(docs);
+ const transaction = new Transaction(txData);
+ transaction.endpointTokenConfig = txData.endpointTokenConfig;
+ transaction.inputTokenCount = txData.inputTokenCount;
+
+ calculateStructuredTokenValue(transaction);
+
+ await transaction.save();
+
+ if (!balance?.enabled) {
+ return;
}
+
+ const incrementValue = transaction.tokenValue as number;
+
+ const balanceResponse = await updateBalance({
+ user: transaction.user as string,
+ incrementValue,
+ });
+
+ return {
+ rate: transaction.rate as number,
+ user: transaction.user.toString() as string,
+ balance: balanceResponse.tokenCredits,
+ [transaction.tokenType as string]: incrementValue,
+ } as TransactionResult;
+ }
+
+ /**
+ * Queries and retrieves transactions based on a given filter.
+ */
+ async function getTransactions(filter: FilterQuery<ITransaction>) {
+ try {
+ const Transaction = mongoose.models.Transaction;
+ return await Transaction.find(filter).lean();
+ } catch (error) {
+ logger.error('Error querying transactions:', error);
+ throw error;
+ }
+ }
+
+ /** Retrieves a user's balance record. */
+ async function findBalanceByUser(user: string): Promise<IBalance | null> {
+ const Balance = mongoose.models.Balance as Model<IBalance>;
+ return Balance.findOne({ user }).lean();
+ }
+
+ /** Upserts balance fields for a user. */
+ async function upsertBalanceFields(
+ user: string,
+ fields: IBalanceUpdate,
+ ): Promise<IBalance | null> {
+ const Balance = mongoose.models.Balance as Model<IBalance>;
+ return Balance.findOneAndUpdate({ user }, { $set: fields }, { upsert: true, new: true }).lean();
+ }
+
+ /** Deletes transactions matching a filter. */
+ async function deleteTransactions(filter: FilterQuery<ITransaction>) {
+ const Transaction = mongoose.models.Transaction;
+ return Transaction.deleteMany(filter);
+ }
+
+ /** Deletes balance records matching a filter. */
+ async function deleteBalances(filter: FilterQuery<IBalance>) {
+ const Balance = mongoose.models.Balance as Model<IBalance>;
+ return Balance.deleteMany(filter);
}
- return { updateBalance, bulkInsertTransactions };
+ return {
+ findBalanceByUser,
+ upsertBalanceFields,
+ getTransactions,
+ deleteTransactions,
+ deleteBalances,
+ createTransaction,
+ createAutoRefillTransaction,
+ createStructuredTransaction,
+ };
}
export type TransactionMethods = ReturnType<typeof createTransactionMethods>;
diff --git a/api/models/tx.spec.js b/packages/data-schemas/src/methods/tx.spec.ts
similarity index 95%
rename from api/models/tx.spec.js
rename to packages/data-schemas/src/methods/tx.spec.ts
index 666cd0a3b8..d1e12e5a55 100644
--- a/api/models/tx.spec.js
+++ b/packages/data-schemas/src/methods/tx.spec.ts
@@ -1,16 +1,18 @@
/** Note: No hard-coded values should be used in this file. */
-const { maxTokensMap } = require('@librechat/api');
-const { EModelEndpoint } = require('librechat-data-provider');
-const {
- defaultRate,
+import { matchModelName, findMatchingPattern } from './test-helpers';
+import { EModelEndpoint } from 'librechat-data-provider';
+import {
+ createTxMethods,
tokenValues,
- getValueKey,
- getMultiplier,
- getPremiumRate,
cacheTokenValues,
- getCacheMultiplier,
premiumTokenValues,
-} = require('./tx');
+ defaultRate,
+} from './tx';
+
+const { getValueKey, getMultiplier, getPremiumRate, getCacheMultiplier } = createTxMethods(
+ {} as typeof import('mongoose'),
+ { matchModelName, findMatchingPattern },
+);
describe('getValueKey', () => {
it('should return "16k" for model name containing "gpt-3.5-turbo-16k"', () => {
@@ -263,6 +265,7 @@ describe('getMultiplier', () => {
});
it('should return defaultRate if tokenType is provided but not found in tokenValues', () => {
+ // @ts-expect-error: intentionally passing invalid tokenType to test error handling
expect(getMultiplier({ valueKey: '8k', tokenType: 'unknownType' })).toBe(defaultRate);
});
@@ -606,7 +609,7 @@ describe('AWS Bedrock Model Tests', () => {
const results = awsModels.map((model) => {
const valueKey = getValueKey(model, EModelEndpoint.bedrock);
const multiplier = getMultiplier({ valueKey, tokenType: 'prompt' });
- return tokenValues[valueKey].prompt && multiplier === tokenValues[valueKey].prompt;
+ return tokenValues[valueKey!].prompt && multiplier === tokenValues[valueKey!].prompt;
});
expect(results.every(Boolean)).toBe(true);
});
@@ -615,7 +618,7 @@ describe('AWS Bedrock Model Tests', () => {
const results = awsModels.map((model) => {
const valueKey = getValueKey(model, EModelEndpoint.bedrock);
const multiplier = getMultiplier({ valueKey, tokenType: 'completion' });
- return tokenValues[valueKey].completion && multiplier === tokenValues[valueKey].completion;
+ return tokenValues[valueKey!].completion && multiplier === tokenValues[valueKey!].completion;
});
expect(results.every(Boolean)).toBe(true);
});
@@ -871,7 +874,7 @@ describe('Deepseek Model Tests', () => {
const results = deepseekModels.map((model) => {
const valueKey = getValueKey(model);
const multiplier = getMultiplier({ valueKey, tokenType: 'prompt' });
- return tokenValues[valueKey].prompt && multiplier === tokenValues[valueKey].prompt;
+ return tokenValues[valueKey!].prompt && multiplier === tokenValues[valueKey!].prompt;
});
expect(results.every(Boolean)).toBe(true);
});
@@ -880,7 +883,7 @@ describe('Deepseek Model Tests', () => {
const results = deepseekModels.map((model) => {
const valueKey = getValueKey(model);
const multiplier = getMultiplier({ valueKey, tokenType: 'completion' });
- return tokenValues[valueKey].completion && multiplier === tokenValues[valueKey].completion;
+ return tokenValues[valueKey!].completion && multiplier === tokenValues[valueKey!].completion;
});
expect(results.every(Boolean)).toBe(true);
});
@@ -890,7 +893,7 @@ describe('Deepseek Model Tests', () => {
const valueKey = getValueKey(model);
expect(valueKey).toBe(model);
const multiplier = getMultiplier({ valueKey, tokenType: 'prompt' });
- const result = tokenValues[valueKey].prompt && multiplier === tokenValues[valueKey].prompt;
+ const result = tokenValues[valueKey!].prompt && multiplier === tokenValues[valueKey!].prompt;
expect(result).toBe(true);
});
@@ -1355,6 +1358,7 @@ describe('getCacheMultiplier', () => {
it('should return null if cacheType is provided but not found in cacheTokenValues', () => {
expect(
+ // @ts-expect-error: intentionally passing invalid cacheType to test error handling
getCacheMultiplier({ valueKey: 'claude-3-5-sonnet', cacheType: 'unknownType' }),
).toBeNull();
});
@@ -1529,8 +1533,8 @@ describe('Google Model Tests', () => {
});
results.forEach(({ valueKey, promptRate, completionRate }) => {
- expect(promptRate).toBe(tokenValues[valueKey].prompt);
- expect(completionRate).toBe(tokenValues[valueKey].completion);
+ expect(promptRate).toBe(tokenValues[valueKey!].prompt);
+ expect(completionRate).toBe(tokenValues[valueKey!].completion);
});
});
@@ -2310,7 +2314,7 @@ describe('Premium Token Pricing', () => {
it('should return null from getPremiumRate when inputTokenCount is undefined or null', () => {
expect(getPremiumRate(premiumModel, 'prompt', undefined)).toBeNull();
- expect(getPremiumRate(premiumModel, 'prompt', null)).toBeNull();
+ expect(getPremiumRate(premiumModel, 'prompt', undefined)).toBeNull();
});
it('should return null from getPremiumRate for models without premium pricing', () => {
@@ -2412,118 +2416,5 @@ describe('Premium Token Pricing', () => {
});
});
-describe('tokens.ts and tx.js sync validation', () => {
- it('should resolve all models in maxTokensMap to pricing via getValueKey', () => {
- const tokensKeys = Object.keys(maxTokensMap[EModelEndpoint.openAI]);
- const txKeys = Object.keys(tokenValues);
-
- const unresolved = [];
-
- tokensKeys.forEach((key) => {
- // Skip legacy token size mappings (e.g., '4k', '8k', '16k', '32k')
- if (/^\d+k$/.test(key)) return;
-
- // Skip generic pattern keys (end with '-' or ':')
- if (key.endsWith('-') || key.endsWith(':')) return;
-
- // Try to resolve via getValueKey
- const resolvedKey = getValueKey(key);
-
- // If it resolves and the resolved key has pricing, success
- if (resolvedKey && txKeys.includes(resolvedKey)) return;
-
- // If it resolves to a legacy key (4k, 8k, etc), also OK
- if (resolvedKey && /^\d+k$/.test(resolvedKey)) return;
-
- // If we get here, this model can't get pricing - flag it
- unresolved.push({
- key,
- resolvedKey: resolvedKey || 'undefined',
- context: maxTokensMap[EModelEndpoint.openAI][key],
- });
- });
-
- if (unresolved.length > 0) {
- console.log('\nModels that cannot resolve to pricing via getValueKey:');
- unresolved.forEach(({ key, resolvedKey, context }) => {
- console.log(` - '${key}' → '${resolvedKey}' (context: ${context})`);
- });
- }
-
- expect(unresolved).toEqual([]);
- });
-
- it('should not have redundant dated variants with same pricing and context as base model', () => {
- const txKeys = Object.keys(tokenValues);
- const redundant = [];
-
- txKeys.forEach((key) => {
- // Check if this is a dated variant (ends with -YYYY-MM-DD)
- if (key.match(/.*-\d{4}-\d{2}-\d{2}$/)) {
- const baseKey = key.replace(/-\d{4}-\d{2}-\d{2}$/, '');
-
- if (txKeys.includes(baseKey)) {
- const variantPricing = tokenValues[key];
- const basePricing = tokenValues[baseKey];
- const variantContext = maxTokensMap[EModelEndpoint.openAI][key];
- const baseContext = maxTokensMap[EModelEndpoint.openAI][baseKey];
-
- const samePricing =
- variantPricing.prompt === basePricing.prompt &&
- variantPricing.completion === basePricing.completion;
- const sameContext = variantContext === baseContext;
-
- if (samePricing && sameContext) {
- redundant.push({
- key,
- baseKey,
- pricing: `${variantPricing.prompt}/${variantPricing.completion}`,
- context: variantContext,
- });
- }
- }
- }
- });
-
- if (redundant.length > 0) {
- console.log('\nRedundant dated variants found (same pricing and context as base):');
- redundant.forEach(({ key, baseKey, pricing, context }) => {
- console.log(` - '${key}' → '${baseKey}' (pricing: ${pricing}, context: ${context})`);
- console.log(` Can be removed - pattern matching will handle it`);
- });
- }
-
- expect(redundant).toEqual([]);
- });
-
- it('should have context windows in tokens.ts for all models with pricing in tx.js (openAI catch-all)', () => {
- const txKeys = Object.keys(tokenValues);
- const missingContext = [];
-
- txKeys.forEach((key) => {
- // Skip legacy token size mappings (4k, 8k, 16k, 32k)
- if (/^\d+k$/.test(key)) return;
-
- // Check if this model has a context window defined
- const context = maxTokensMap[EModelEndpoint.openAI][key];
-
- if (!context) {
- const pricing = tokenValues[key];
- missingContext.push({
- key,
- pricing: `${pricing.prompt}/${pricing.completion}`,
- });
- }
- });
-
- if (missingContext.length > 0) {
- console.log('\nModels with pricing but missing context in tokens.ts:');
- missingContext.forEach(({ key, pricing }) => {
- console.log(` - '${key}' (pricing: ${pricing})`);
- console.log(` Add to tokens.ts openAIModels/bedrockModels/etc.`);
- });
- }
-
- expect(missingContext).toEqual([]);
- });
-});
+// Cross-package sync validation tests (tokens.ts ↔ tx.ts) moved to
+// packages/api tests since they require maxTokensMap from @librechat/api.
diff --git a/api/models/tx.js b/packages/data-schemas/src/methods/tx.ts
similarity index 63%
rename from api/models/tx.js
rename to packages/data-schemas/src/methods/tx.ts
index ce14fad3a0..23b22353dc 100644
--- a/api/models/tx.js
+++ b/packages/data-schemas/src/methods/tx.ts
@@ -1,44 +1,43 @@
-const { matchModelName, findMatchingPattern } = require('@librechat/api');
-const defaultRate = 6;
-
/**
* Token Pricing Configuration
*
* Pattern Matching
* ================
- * `findMatchingPattern` (from @librechat/api) uses `modelName.includes(key)` and selects
- * the LONGEST matching key. If a key's length equals the model name's length (exact match),
- * it returns immediately. Definition order does NOT affect correctness.
- *
- * Key ordering matters only for:
- * 1. Performance: list older/less common models first so newer/common models
- * are found earlier in the reverse scan.
- * 2. Same-length tie-breaking: the last-defined key wins on equal-length matches.
+ * `findMatchingPattern` uses `modelName.includes(key)` and selects the **longest**
+ * matching key. If a key's length equals the model name's length (exact match), it
+ * returns immediately — no further keys are checked.
*
- * This applies to BOTH `tokenValues` and `cacheTokenValues` objects.
+ * For keys of different lengths, definition order does not affect the result — the
+ * longest match always wins. For **same-length ties**, the function iterates in
+ * reverse, so the last-defined key wins. Key ordering therefore matters for:
+ * 1. **Performance**: list older/legacy models first, newer models last — newer
+ * models are more commonly used and will match earlier in the reverse scan.
+ * 2. **Same-length tie-breaking**: when two keys of equal length both match,
+ * the last-defined key wins.
*/
-/**
- * AWS Bedrock pricing
- * source: https://aws.amazon.com/bedrock/pricing/
- */
-const bedrockValues = {
- // Basic llama2 patterns (base defaults to smallest variant)
+export interface TxDeps {
+ /** From @librechat/api — matches a model name to a canonical key. */
+ matchModelName: (model: string, endpoint?: string) => string | undefined;
+ /** From @librechat/api — finds the longest key in `values` whose key is a substring of `model`. */
+ findMatchingPattern: (model: string, values: Record<string, unknown>) => string | undefined;
+}
+
+export const defaultRate = 6;
+
+/** AWS Bedrock pricing (source: https://aws.amazon.com/bedrock/pricing/) */
+const bedrockValues: Record<string, { prompt: number; completion: number }> = {
llama2: { prompt: 0.75, completion: 1.0 },
'llama-2': { prompt: 0.75, completion: 1.0 },
'llama2-13b': { prompt: 0.75, completion: 1.0 },
'llama2:70b': { prompt: 1.95, completion: 2.56 },
'llama2-70b': { prompt: 1.95, completion: 2.56 },
-
- // Basic llama3 patterns (base defaults to smallest variant)
llama3: { prompt: 0.3, completion: 0.6 },
'llama-3': { prompt: 0.3, completion: 0.6 },
'llama3-8b': { prompt: 0.3, completion: 0.6 },
'llama3:8b': { prompt: 0.3, completion: 0.6 },
'llama3-70b': { prompt: 2.65, completion: 3.5 },
'llama3:70b': { prompt: 2.65, completion: 3.5 },
-
- // llama3-x-Nb pattern (base defaults to smallest variant)
'llama3-1': { prompt: 0.22, completion: 0.22 },
'llama3-1-8b': { prompt: 0.22, completion: 0.22 },
'llama3-1-70b': { prompt: 0.72, completion: 0.72 },
@@ -50,8 +49,6 @@ const bedrockValues = {
'llama3-2-90b': { prompt: 0.72, completion: 0.72 },
'llama3-3': { prompt: 2.65, completion: 3.5 },
'llama3-3-70b': { prompt: 2.65, completion: 3.5 },
-
- // llama3.x:Nb pattern (base defaults to smallest variant)
'llama3.1': { prompt: 0.22, completion: 0.22 },
'llama3.1:8b': { prompt: 0.22, completion: 0.22 },
'llama3.1:70b': { prompt: 0.72, completion: 0.72 },
@@ -63,8 +60,6 @@ const bedrockValues = {
'llama3.2:90b': { prompt: 0.72, completion: 0.72 },
'llama3.3': { prompt: 2.65, completion: 3.5 },
'llama3.3:70b': { prompt: 2.65, completion: 3.5 },
-
- // llama-3.x-Nb pattern (base defaults to smallest variant)
'llama-3.1': { prompt: 0.22, completion: 0.22 },
'llama-3.1-8b': { prompt: 0.22, completion: 0.22 },
'llama-3.1-70b': { prompt: 0.72, completion: 0.72 },
@@ -83,21 +78,17 @@ const bedrockValues = {
'mistral-large-2407': { prompt: 3.0, completion: 9.0 },
'command-text': { prompt: 1.5, completion: 2.0 },
'command-light': { prompt: 0.3, completion: 0.6 },
- // AI21 models
'j2-mid': { prompt: 12.5, completion: 12.5 },
'j2-ultra': { prompt: 18.8, completion: 18.8 },
'jamba-instruct': { prompt: 0.5, completion: 0.7 },
- // Amazon Titan models
'titan-text-lite': { prompt: 0.15, completion: 0.2 },
'titan-text-express': { prompt: 0.2, completion: 0.6 },
'titan-text-premier': { prompt: 0.5, completion: 1.5 },
- // Amazon Nova models
'nova-micro': { prompt: 0.035, completion: 0.14 },
'nova-lite': { prompt: 0.06, completion: 0.24 },
'nova-pro': { prompt: 0.8, completion: 3.2 },
'nova-premier': { prompt: 2.5, completion: 12.5 },
'deepseek.r1': { prompt: 1.35, completion: 5.4 },
- // Moonshot/Kimi models on Bedrock
'moonshot.kimi': { prompt: 0.6, completion: 2.5 },
'moonshot.kimi-k2': { prompt: 0.6, completion: 2.5 },
'moonshot.kimi-k2.5': { prompt: 0.6, completion: 3.0 },
@@ -107,23 +98,19 @@ const bedrockValues = {
/**
* Mapping of model token sizes to their respective multipliers for prompt and completion.
* The rates are 1 USD per 1M tokens.
- * @type {Object.<string, {prompt: number, completion: number}>}
*/
-const tokenValues = Object.assign(
+export const tokenValues: Record<string, { prompt: number; completion: number }> = Object.assign(
{
- // Legacy token size mappings (generic patterns - check LAST)
'8k': { prompt: 30, completion: 60 },
'32k': { prompt: 60, completion: 120 },
'4k': { prompt: 1.5, completion: 2 },
'16k': { prompt: 3, completion: 4 },
- // Generic fallback patterns (check LAST)
'claude-': { prompt: 0.8, completion: 2.4 },
deepseek: { prompt: 0.28, completion: 0.42 },
command: { prompt: 0.38, completion: 0.38 },
- gemma: { prompt: 0.02, completion: 0.04 }, // Base pattern (using gemma-3n-e4b pricing)
+ gemma: { prompt: 0.02, completion: 0.04 },
gemini: { prompt: 0.5, completion: 1.5 },
'gpt-oss': { prompt: 0.05, completion: 0.2 },
- // Specific model variants (check FIRST - more specific patterns at end)
'gpt-3.5-turbo-1106': { prompt: 1, completion: 2 },
'gpt-3.5-turbo-0125': { prompt: 0.5, completion: 1.5 },
'gpt-4-1106': { prompt: 10, completion: 30 },
@@ -176,16 +163,16 @@ const tokenValues = Object.assign(
'deepseek-reasoner': { prompt: 0.28, completion: 0.42 },
'deepseek-r1': { prompt: 0.4, completion: 2.0 },
'deepseek-v3': { prompt: 0.2, completion: 0.8 },
- 'gemma-2': { prompt: 0.01, completion: 0.03 }, // Base pattern (using gemma-2-9b pricing)
- 'gemma-3': { prompt: 0.02, completion: 0.04 }, // Base pattern (using gemma-3n-e4b pricing)
+ 'gemma-2': { prompt: 0.01, completion: 0.03 },
+ 'gemma-3': { prompt: 0.02, completion: 0.04 },
'gemma-3-27b': { prompt: 0.09, completion: 0.16 },
'gemini-1.5': { prompt: 2.5, completion: 10 },
'gemini-1.5-flash': { prompt: 0.15, completion: 0.6 },
'gemini-1.5-flash-8b': { prompt: 0.075, completion: 0.3 },
- 'gemini-2.0': { prompt: 0.1, completion: 0.4 }, // Base pattern (using 2.0-flash pricing)
+ 'gemini-2.0': { prompt: 0.1, completion: 0.4 },
'gemini-2.0-flash': { prompt: 0.1, completion: 0.4 },
'gemini-2.0-flash-lite': { prompt: 0.075, completion: 0.3 },
- 'gemini-2.5': { prompt: 0.3, completion: 2.5 }, // Base pattern (using 2.5-flash pricing)
+ 'gemini-2.5': { prompt: 0.3, completion: 2.5 },
'gemini-2.5-flash': { prompt: 0.3, completion: 2.5 },
'gemini-2.5-flash-lite': { prompt: 0.1, completion: 0.4 },
'gemini-2.5-pro': { prompt: 1.25, completion: 10 },
@@ -195,7 +182,7 @@ const tokenValues = Object.assign(
'gemini-3.1': { prompt: 2, completion: 12 },
'gemini-3.1-flash-lite': { prompt: 0.25, completion: 1.5 },
'gemini-pro-vision': { prompt: 0.5, completion: 1.5 },
- grok: { prompt: 2.0, completion: 10.0 }, // Base pattern defaults to grok-2
+ grok: { prompt: 2.0, completion: 10.0 },
'grok-beta': { prompt: 5.0, completion: 15.0 },
'grok-vision-beta': { prompt: 5.0, completion: 15.0 },
'grok-2': { prompt: 2.0, completion: 10.0 },
@@ -210,7 +197,7 @@ const tokenValues = Object.assign(
'grok-3-mini-fast': { prompt: 0.6, completion: 4 },
'grok-4': { prompt: 3.0, completion: 15.0 },
'grok-4-fast': { prompt: 0.2, completion: 0.5 },
- 'grok-4-1-fast': { prompt: 0.2, completion: 0.5 }, // covers reasoning & non-reasoning variants
+ 'grok-4-1-fast': { prompt: 0.2, completion: 0.5 },
'grok-code-fast': { prompt: 0.2, completion: 1.5 },
codestral: { prompt: 0.3, completion: 0.9 },
'ministral-3b': { prompt: 0.04, completion: 0.04 },
@@ -220,10 +207,9 @@ const tokenValues = Object.assign(
'pixtral-large': { prompt: 2.0, completion: 6.0 },
'mistral-large': { prompt: 2.0, completion: 6.0 },
'mixtral-8x22b': { prompt: 0.65, completion: 0.65 },
- // Moonshot/Kimi models (base patterns first, specific patterns last for correct matching)
- kimi: { prompt: 0.6, completion: 2.5 }, // Base pattern
- moonshot: { prompt: 2.0, completion: 5.0 }, // Base pattern (using 128k pricing)
- 'kimi-latest': { prompt: 0.2, completion: 2.0 }, // Uses 8k/32k/128k pricing dynamically
+ kimi: { prompt: 0.6, completion: 2.5 },
+ moonshot: { prompt: 2.0, completion: 5.0 },
+ 'kimi-latest': { prompt: 0.2, completion: 2.0 },
'kimi-k2': { prompt: 0.6, completion: 2.5 },
'kimi-k2.5': { prompt: 0.6, completion: 3.0 },
'kimi-k2-turbo': { prompt: 1.15, completion: 8.0 },
@@ -245,12 +231,10 @@ const tokenValues = Object.assign(
'moonshot-v1-128k': { prompt: 2.0, completion: 5.0 },
'moonshot-v1-128k-vision': { prompt: 2.0, completion: 5.0 },
'moonshot-v1-128k-vision-preview': { prompt: 2.0, completion: 5.0 },
- // GPT-OSS models (specific sizes)
'gpt-oss:20b': { prompt: 0.05, completion: 0.2 },
'gpt-oss-20b': { prompt: 0.05, completion: 0.2 },
'gpt-oss:120b': { prompt: 0.15, completion: 0.6 },
'gpt-oss-120b': { prompt: 0.15, completion: 0.6 },
- // GLM models (Zhipu AI) - general to specific
glm4: { prompt: 0.1, completion: 0.1 },
'glm-4': { prompt: 0.1, completion: 0.1 },
'glm-4-32b': { prompt: 0.1, completion: 0.1 },
@@ -258,26 +242,22 @@ const tokenValues = Object.assign(
'glm-4.5-air': { prompt: 0.14, completion: 0.86 },
'glm-4.5v': { prompt: 0.6, completion: 1.8 },
'glm-4.6': { prompt: 0.5, completion: 1.75 },
- // Qwen models
- qwen: { prompt: 0.08, completion: 0.33 }, // Qwen base pattern (using qwen2.5-72b pricing)
- 'qwen2.5': { prompt: 0.08, completion: 0.33 }, // Qwen 2.5 base pattern
+ qwen: { prompt: 0.08, completion: 0.33 },
+ 'qwen2.5': { prompt: 0.08, completion: 0.33 },
'qwen-turbo': { prompt: 0.05, completion: 0.2 },
'qwen-plus': { prompt: 0.4, completion: 1.2 },
'qwen-max': { prompt: 1.6, completion: 6.4 },
'qwq-32b': { prompt: 0.15, completion: 0.4 },
- // Qwen3 models
- qwen3: { prompt: 0.035, completion: 0.138 }, // Qwen3 base pattern (using qwen3-4b pricing)
+ qwen3: { prompt: 0.035, completion: 0.138 },
'qwen3-8b': { prompt: 0.035, completion: 0.138 },
'qwen3-14b': { prompt: 0.05, completion: 0.22 },
'qwen3-30b-a3b': { prompt: 0.06, completion: 0.22 },
'qwen3-32b': { prompt: 0.05, completion: 0.2 },
'qwen3-235b-a22b': { prompt: 0.08, completion: 0.55 },
- // Qwen3 VL (Vision-Language) models
'qwen3-vl-8b-thinking': { prompt: 0.18, completion: 2.1 },
'qwen3-vl-8b-instruct': { prompt: 0.18, completion: 0.69 },
'qwen3-vl-30b-a3b': { prompt: 0.29, completion: 1.0 },
'qwen3-vl-235b-a22b': { prompt: 0.3, completion: 1.2 },
- // Qwen3 specialized models
'qwen3-max': { prompt: 1.2, completion: 6 },
'qwen3-coder': { prompt: 0.22, completion: 0.95 },
'qwen3-coder-30b-a3b': { prompt: 0.06, completion: 0.25 },
@@ -290,11 +270,9 @@ const tokenValues = Object.assign(
/**
* Mapping of model token sizes to their respective multipliers for cached input, read and write.
- * See Anthropic's documentation on this: https://docs.anthropic.com/en/docs/build-with-claude/prompt-caching#pricing
* The rates are 1 USD per 1M tokens.
- * @type {Object.<string, {write: number, read: number }>}
*/
-const cacheTokenValues = {
+export const cacheTokenValues: Record<string, { write: number; read: number }> = {
'claude-3.7-sonnet': { write: 3.75, read: 0.3 },
'claude-3-7-sonnet': { write: 3.75, read: 0.3 },
'claude-3.5-sonnet': { write: 3.75, read: 0.3 },
@@ -308,11 +286,6 @@ const cacheTokenValues = {
'claude-opus-4': { write: 18.75, read: 1.5 },
'claude-opus-4-5': { write: 6.25, read: 0.5 },
'claude-opus-4-6': { write: 6.25, read: 0.5 },
- // OpenAI models — cached input discount varies by family:
- // gpt-4o (incl. mini), o1 (incl. mini/preview): 50% off
- // gpt-4.1 (incl. mini/nano), o3 (incl. mini), o4-mini: 75% off
- // gpt-5.x (excl. pro variants): 90% off
- // gpt-5-pro, gpt-5.2-pro, gpt-5.4-pro: no caching
'gpt-4o': { write: 2.5, read: 1.25 },
'gpt-4o-mini': { write: 0.15, read: 0.075 },
'gpt-4.1': { write: 2, read: 0.5 },
@@ -331,11 +304,9 @@ const cacheTokenValues = {
o3: { write: 2, read: 0.5 },
'o3-mini': { write: 1.1, read: 0.275 },
'o4-mini': { write: 1.1, read: 0.275 },
- // DeepSeek models - cache hit: $0.028/1M, cache miss: $0.28/1M
deepseek: { write: 0.28, read: 0.028 },
'deepseek-chat': { write: 0.28, read: 0.028 },
'deepseek-reasoner': { write: 0.28, read: 0.028 },
- // Moonshot/Kimi models - cache hit: $0.15/1M (k2) or $0.10/1M (k2.5), cache miss: $0.60/1M
kimi: { write: 0.6, read: 0.15 },
'kimi-k2': { write: 0.6, read: 0.15 },
'kimi-k2.5': { write: 0.6, read: 0.1 },
@@ -355,171 +326,169 @@ const cacheTokenValues = {
/**
* Premium (tiered) pricing for models whose rates change based on prompt size.
- * Each entry specifies the token threshold and the rates that apply above it.
- * @type {Object.<string, {threshold: number, prompt: number, completion: number}>}
*/
-const premiumTokenValues = {
+export const premiumTokenValues: Record<
+ string,
+ { threshold: number; prompt: number; completion: number }
+> = {
'claude-opus-4-6': { threshold: 200000, prompt: 10, completion: 37.5 },
'claude-sonnet-4-6': { threshold: 200000, prompt: 6, completion: 22.5 },
'gemini-3.1': { threshold: 200000, prompt: 4, completion: 18 },
};
-/**
- * Retrieves the key associated with a given model name.
- *
- * @param {string} model - The model name to match.
- * @param {string} endpoint - The endpoint name to match.
- * @returns {string|undefined} The key corresponding to the model name, or undefined if no match is found.
- */
-const getValueKey = (model, endpoint) => {
- if (!model || typeof model !== 'string') {
- return undefined;
- }
+export function createTxMethods(_mongoose: typeof import('mongoose'), txDeps: TxDeps) {
+ const { matchModelName, findMatchingPattern } = txDeps;
- // Use findMatchingPattern directly against tokenValues for efficient lookup
- if (!endpoint || (typeof endpoint === 'string' && !tokenValues[endpoint])) {
- const matchedKey = findMatchingPattern(model, tokenValues);
- if (matchedKey) {
- return matchedKey;
+ /**
+ * Retrieves the key associated with a given model name.
+ */
+ function getValueKey(model: string, endpoint?: string): string | undefined {
+ if (!model || typeof model !== 'string') {
+ return undefined;
+ }
+
+ if (!endpoint || (typeof endpoint === 'string' && !tokenValues[endpoint])) {
+ const matchedKey = findMatchingPattern(model, tokenValues);
+ if (matchedKey) {
+ return matchedKey;
+ }
+ }
+
+ const modelName = matchModelName(model, endpoint);
+ if (!modelName) {
+ return undefined;
+ }
+
+ if (modelName.includes('gpt-3.5-turbo-16k')) {
+ return '16k';
+ } else if (modelName.includes('gpt-3.5')) {
+ return '4k';
+ } else if (modelName.includes('gpt-4-vision')) {
+ return 'gpt-4-1106';
+ } else if (modelName.includes('gpt-4-0125')) {
+ return 'gpt-4-1106';
+ } else if (modelName.includes('gpt-4-turbo')) {
+ return 'gpt-4-1106';
+ } else if (modelName.includes('gpt-4-32k')) {
+ return '32k';
+ } else if (modelName.includes('gpt-4')) {
+ return '8k';
}
- }
- // Fallback: use matchModelName for edge cases and legacy handling
- const modelName = matchModelName(model, endpoint);
- if (!modelName) {
return undefined;
}
- // Legacy token size mappings and aliases for older models
- if (modelName.includes('gpt-3.5-turbo-16k')) {
- return '16k';
- } else if (modelName.includes('gpt-3.5')) {
- return '4k';
- } else if (modelName.includes('gpt-4-vision')) {
- return 'gpt-4-1106'; // Alias for gpt-4-vision
- } else if (modelName.includes('gpt-4-0125')) {
- return 'gpt-4-1106'; // Alias for gpt-4-0125
- } else if (modelName.includes('gpt-4-turbo')) {
- return 'gpt-4-1106'; // Alias for gpt-4-turbo
- } else if (modelName.includes('gpt-4-32k')) {
- return '32k';
- } else if (modelName.includes('gpt-4')) {
- return '8k';
+ /**
+ * Checks if premium (tiered) pricing applies and returns the premium rate.
+ */
+ function getPremiumRate(
+ valueKey: string,
+ tokenType: string,
+ inputTokenCount?: number,
+ ): number | null {
+ if (inputTokenCount == null) {
+ return null;
+ }
+ const premiumEntry = premiumTokenValues[valueKey];
+ if (!premiumEntry || inputTokenCount <= premiumEntry.threshold) {
+ return null;
+ }
+ return premiumEntry[tokenType as 'prompt' | 'completion'] ?? null;
}
- return undefined;
-};
+ /**
+ * Retrieves the multiplier for a given value key and token type.
+ */
+ function getMultiplier({
+ model,
+ valueKey,
+ endpoint,
+ tokenType,
+ inputTokenCount,
+ endpointTokenConfig,
+ }: {
+ model?: string;
+ valueKey?: string;
+ endpoint?: string;
+ tokenType?: 'prompt' | 'completion';
+ inputTokenCount?: number;
+ endpointTokenConfig?: Record<string, Record<string, number>>;
+ }): number {
+ if (endpointTokenConfig && model) {
+ return endpointTokenConfig?.[model]?.[tokenType as string] ?? defaultRate;
+ }
-/**
- * Retrieves the multiplier for a given value key and token type. If no value key is provided,
- * it attempts to derive it from the model name.
- *
- * @param {Object} params - The parameters for the function.
- * @param {string} [params.valueKey] - The key corresponding to the model name.
- * @param {'prompt' | 'completion'} [params.tokenType] - The type of token (e.g., 'prompt' or 'completion').
- * @param {string} [params.model] - The model name to derive the value key from if not provided.
- * @param {string} [params.endpoint] - The endpoint name to derive the value key from if not provided.
- * @param {EndpointTokenConfig} [params.endpointTokenConfig] - The token configuration for the endpoint.
- * @param {number} [params.inputTokenCount] - Total input token count for tiered pricing.
- * @returns {number} The multiplier for the given parameters, or a default value if not found.
- */
-const getMultiplier = ({
- model,
- valueKey,
- endpoint,
- tokenType,
- inputTokenCount,
- endpointTokenConfig,
-}) => {
- if (endpointTokenConfig) {
- return endpointTokenConfig?.[model]?.[tokenType] ?? defaultRate;
- }
+ if (valueKey && tokenType) {
+ const premiumRate = getPremiumRate(valueKey, tokenType, inputTokenCount);
+ if (premiumRate != null) {
+ return premiumRate;
+ }
+ return tokenValues[valueKey]?.[tokenType] ?? defaultRate;
+ }
+
+ if (!tokenType || !model) {
+ return 1;
+ }
+
+ valueKey = getValueKey(model, endpoint);
+ if (!valueKey) {
+ return defaultRate;
+ }
- if (valueKey && tokenType) {
const premiumRate = getPremiumRate(valueKey, tokenType, inputTokenCount);
if (premiumRate != null) {
return premiumRate;
}
- return tokenValues[valueKey]?.[tokenType] ?? defaultRate;
- }
-
- if (!tokenType || !model) {
- return 1;
- }
- valueKey = getValueKey(model, endpoint);
- if (!valueKey) {
- return defaultRate;
+ return tokenValues[valueKey]?.[tokenType] ?? defaultRate;
}
- const premiumRate = getPremiumRate(valueKey, tokenType, inputTokenCount);
- if (premiumRate != null) {
- return premiumRate;
- }
+ /**
+ * Retrieves the cache multiplier for a given value key and token type.
+ */
+ function getCacheMultiplier({
+ valueKey,
+ cacheType,
+ model,
+ endpoint,
+ endpointTokenConfig,
+ }: {
+ valueKey?: string;
+ cacheType?: 'write' | 'read';
+ model?: string;
+ endpoint?: string;
+ endpointTokenConfig?: Record<string, Record<string, number>>;
+ }): number | null {
+ if (endpointTokenConfig && model) {
+ return endpointTokenConfig?.[model]?.[cacheType as string] ?? null;
+ }
- return tokenValues[valueKey]?.[tokenType] ?? defaultRate;
-};
+ if (valueKey && cacheType) {
+ return cacheTokenValues[valueKey]?.[cacheType] ?? null;
+ }
-/**
- * Checks if premium (tiered) pricing applies and returns the premium rate.
- * Each model defines its own threshold in `premiumTokenValues`.
- * @param {string} valueKey
- * @param {string} tokenType
- * @param {number} [inputTokenCount]
- * @returns {number|null}
- */
-const getPremiumRate = (valueKey, tokenType, inputTokenCount) => {
- if (inputTokenCount == null) {
- return null;
- }
- const premiumEntry = premiumTokenValues[valueKey];
- if (!premiumEntry || inputTokenCount <= premiumEntry.threshold) {
- return null;
- }
- return premiumEntry[tokenType] ?? null;
-};
+ if (!cacheType || !model) {
+ return null;
+ }
-/**
- * Retrieves the cache multiplier for a given value key and token type. If no value key is provided,
- * it attempts to derive it from the model name.
- *
- * @param {Object} params - The parameters for the function.
- * @param {string} [params.valueKey] - The key corresponding to the model name.
- * @param {'write' | 'read'} [params.cacheType] - The type of token (e.g., 'write' or 'read').
- * @param {string} [params.model] - The model name to derive the value key from if not provided.
- * @param {string} [params.endpoint] - The endpoint name to derive the value key from if not provided.
- * @param {EndpointTokenConfig} [params.endpointTokenConfig] - The token configuration for the endpoint.
- * @returns {number | null} The multiplier for the given parameters, or `null` if not found.
- */
-const getCacheMultiplier = ({ valueKey, cacheType, model, endpoint, endpointTokenConfig }) => {
- if (endpointTokenConfig) {
- return endpointTokenConfig?.[model]?.[cacheType] ?? null;
- }
+ valueKey = getValueKey(model, endpoint);
+ if (!valueKey) {
+ return null;
+ }
- if (valueKey && cacheType) {
return cacheTokenValues[valueKey]?.[cacheType] ?? null;
}
- if (!cacheType || !model) {
- return null;
- }
-
- valueKey = getValueKey(model, endpoint);
- if (!valueKey) {
- return null;
- }
+ return {
+ tokenValues,
+ premiumTokenValues,
+ getValueKey,
+ getMultiplier,
+ getPremiumRate,
+ getCacheMultiplier,
+ defaultRate,
+ cacheTokenValues,
+ };
+}
- // If we got this far, and values[cacheType] is undefined somehow, return a rough average of default multipliers
- return cacheTokenValues[valueKey]?.[cacheType] ?? null;
-};
-
-module.exports = {
- tokenValues,
- premiumTokenValues,
- getValueKey,
- getMultiplier,
- getPremiumRate,
- getCacheMultiplier,
- defaultRate,
- cacheTokenValues,
-};
+export type TxMethods = ReturnType<typeof createTxMethods>;
diff --git a/packages/data-schemas/src/methods/userGroup.ts b/packages/data-schemas/src/methods/userGroup.ts
index f6b57095dc..5c683268b3 100644
--- a/packages/data-schemas/src/methods/userGroup.ts
+++ b/packages/data-schemas/src/methods/userGroup.ts
@@ -589,6 +589,61 @@ export function createUserGroupMethods(mongoose: typeof import('mongoose')) {
return combined;
}
+ /**
+ * Removes a user from all groups they belong to.
+ * @param userId - The user ID (or ObjectId) of the member to remove
+ */
+ async function removeUserFromAllGroups(userId: string | Types.ObjectId): Promise<void> {
+ const Group = mongoose.models.Group as Model<IGroup>;
+ await Group.updateMany({ memberIds: userId }, { $pullAll: { memberIds: [userId] } });
+ }
+
+ /**
+ * Finds a single group matching the given filter.
+ * @param filter - MongoDB filter query
+ */
+ async function findGroupByQuery(
+ filter: Record<string, unknown>,
+ session?: ClientSession,
+ ): Promise<IGroup | null> {
+ const Group = mongoose.models.Group as Model<IGroup>;
+ const query = Group.findOne(filter);
+ if (session) {
+ query.session(session);
+ }
+ return query.lean();
+ }
+
+ /**
+ * Updates a group by its ID.
+ * @param groupId - The group's ObjectId
+ * @param data - Fields to set via $set
+ */
+ async function updateGroupById(
+ groupId: string | Types.ObjectId,
+ data: Record<string, unknown>,
+ session?: ClientSession,
+ ): Promise<IGroup | null> {
+ const Group = mongoose.models.Group as Model<IGroup>;
+ const options = { new: true, ...(session ? { session } : {}) };
+ return Group.findByIdAndUpdate(groupId, { $set: data }, options).lean();
+ }
+
+ /**
+ * Bulk-updates groups matching a filter.
+ * @param filter - MongoDB filter query
+ * @param update - Update operations
+ * @param options - Optional query options (e.g., { session })
+ */
+ async function bulkUpdateGroups(
+ filter: Record<string, unknown>,
+ update: Record<string, unknown>,
+ options?: { session?: ClientSession },
+ ) {
+ const Group = mongoose.models.Group as Model<IGroup>;
+ return Group.updateMany(filter, update, options || {});
+ }
+
return {
findGroupById,
findGroupByExternalId,
@@ -598,6 +653,10 @@ export function createUserGroupMethods(mongoose: typeof import('mongoose')) {
upsertGroupByExternalId,
addUserToGroup,
removeUserFromGroup,
+ removeUserFromAllGroups,
+ findGroupByQuery,
+ updateGroupById,
+ bulkUpdateGroups,
getUserGroups,
getUserPrincipals,
syncUserEntraGroups,
diff --git a/packages/data-schemas/src/types/agent.ts b/packages/data-schemas/src/types/agent.ts
index f163ab63bd..1171028c5d 100644
--- a/packages/data-schemas/src/types/agent.ts
+++ b/packages/data-schemas/src/types/agent.ts
@@ -1,5 +1,5 @@
import { Document, Types } from 'mongoose';
-import type { GraphEdge, AgentToolOptions } from 'librechat-data-provider';
+import type { GraphEdge, AgentToolOptions, AgentToolResources } from 'librechat-data-provider';
export interface ISupportContact {
name?: string;
@@ -32,7 +32,7 @@ export interface IAgent extends Omit<Document, 'model'> {
agent_ids?: string[];
edges?: GraphEdge[];
conversation_starters?: string[];
- tool_resources?: unknown;
+ tool_resources?: AgentToolResources;
versions?: Omit<IAgent, 'versions'>[];
category: string;
support_contact?: ISupportContact;
diff --git a/packages/data-schemas/src/types/balance.ts b/packages/data-schemas/src/types/balance.ts
index d9497ff514..e5eb4c4f15 100644
--- a/packages/data-schemas/src/types/balance.ts
+++ b/packages/data-schemas/src/types/balance.ts
@@ -10,3 +10,14 @@ export interface IBalance extends Document {
lastRefill: Date;
refillAmount: number;
}
+
+/** Plain data fields for creating or updating a balance record (no Mongoose Document methods) */
+export interface IBalanceUpdate {
+ user?: string;
+ tokenCredits?: number;
+ autoRefillEnabled?: boolean;
+ refillIntervalValue?: number;
+ refillIntervalUnit?: string;
+ refillAmount?: number;
+ lastRefill?: Date;
+}
diff --git a/packages/data-schemas/src/types/message.ts b/packages/data-schemas/src/types/message.ts
index 2ca262a6bb..c4e96b34ba 100644
--- a/packages/data-schemas/src/types/message.ts
+++ b/packages/data-schemas/src/types/message.ts
@@ -11,7 +11,7 @@ export interface IMessage extends Document {
conversationSignature?: string;
clientId?: string;
invocationId?: number;
- parentMessageId?: string;
+ parentMessageId?: string | null;
tokenCount?: number;
summaryTokenCount?: number;
sender?: string;
@@ -40,7 +40,7 @@ export interface IMessage extends Document {
addedConvo?: boolean;
metadata?: Record<string, unknown>;
attachments?: unknown[];
- expiredAt?: Date;
+ expiredAt?: Date | null;
createdAt?: Date;
updatedAt?: Date;
}
diff --git a/packages/data-schemas/src/utils/index.ts b/packages/data-schemas/src/utils/index.ts
index af47bf8855..626233f1be 100644
--- a/packages/data-schemas/src/utils/index.ts
+++ b/packages/data-schemas/src/utils/index.ts
@@ -1 +1,3 @@
+export * from './string';
+export * from './tempChatRetention';
export * from './transactions';
diff --git a/packages/data-schemas/src/utils/string.ts b/packages/data-schemas/src/utils/string.ts
new file mode 100644
index 0000000000..6b92811b09
--- /dev/null
+++ b/packages/data-schemas/src/utils/string.ts
@@ -0,0 +1,6 @@
+/**
+ * Escapes special regex characters in a string.
+ */
+export function escapeRegExp(str: string): string {
+ return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
diff --git a/packages/api/src/utils/tempChatRetention.spec.ts b/packages/data-schemas/src/utils/tempChatRetention.spec.ts
similarity index 98%
rename from packages/api/src/utils/tempChatRetention.spec.ts
rename to packages/data-schemas/src/utils/tempChatRetention.spec.ts
index ef029cdde5..847088ab7c 100644
--- a/packages/api/src/utils/tempChatRetention.spec.ts
+++ b/packages/data-schemas/src/utils/tempChatRetention.spec.ts
@@ -1,4 +1,4 @@
-import type { AppConfig } from '@librechat/data-schemas';
+import type { AppConfig } from '~/types';
import {
createTempChatExpirationDate,
getTempChatRetentionHours,
diff --git a/packages/api/src/utils/tempChatRetention.ts b/packages/data-schemas/src/utils/tempChatRetention.ts
similarity index 95%
rename from packages/api/src/utils/tempChatRetention.ts
rename to packages/data-schemas/src/utils/tempChatRetention.ts
index eaa6ad2029..663228c13e 100644
--- a/packages/api/src/utils/tempChatRetention.ts
+++ b/packages/data-schemas/src/utils/tempChatRetention.ts
@@ -1,5 +1,5 @@
-import { logger } from '@librechat/data-schemas';
-import type { AppConfig } from '@librechat/data-schemas';
+import logger from '~/config/winston';
+import type { AppConfig } from '~/types';
/**
* Default retention period for temporary chats in hours
diff --git a/packages/data-schemas/tsconfig.build.json b/packages/data-schemas/tsconfig.build.json
new file mode 100644
index 0000000000..79e86005cc
--- /dev/null
+++ b/packages/data-schemas/tsconfig.build.json
@@ -0,0 +1,10 @@
+{
+ "extends": "./tsconfig.json",
+ "compilerOptions": {
+ "noEmit": false,
+ "declaration": true,
+ "declarationDir": "dist/types",
+ "outDir": "dist"
+ },
+ "exclude": ["node_modules", "dist", "**/*.spec.ts"]
+}
diff --git a/packages/data-schemas/tsconfig.json b/packages/data-schemas/tsconfig.json
index 57a321c866..b9829ce4e7 100644
--- a/packages/data-schemas/tsconfig.json
+++ b/packages/data-schemas/tsconfig.json
@@ -3,9 +3,8 @@
"target": "ES2019",
"module": "ESNext",
"moduleResolution": "node",
- "declaration": true,
- "declarationDir": "dist/types",
- "outDir": "dist",
+ "declaration": false,
+ "noEmit": true,
"strict": true,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
@@ -19,5 +18,5 @@
}
},
"include": ["src/**/*"],
- "exclude": ["node_modules", "dist", "tests"]
+ "exclude": ["node_modules", "dist"]
}